net.grinder.util

Class Directory

java.lang.Object

net.grinder.util.Directory

All Implemented Interfaces:

Serializable

public final class Directory
extends Object
implements Serializable

Wrapper around a directory path that behaves in a similar manner to java.io.File. Provides utility methods for working with the directory represented by the path.

A Directory be constructed with a path that represents an existing directory, or a path that represents no existing file. The physical directory can be created later using create().

Author:

Philip Aston

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Directory.DirectoryException An exception type used to report Directory related problems.

Constructor Summary

Constructors

Constructor and Description
Directory() Constructor that builds a Directory for the current working directory.
Directory(File directory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyTo(Directory target, boolean incremental) Copy contents of the directory to the target directory.
void	create() Create the directory if it doesn't exist.
void	delete() Delete the directory.
void	deleteContents() Delete the contents of the directory.
boolean	equals(Object o) Delegate equality to our File.
File	getFile() Get as a File.
File	getFile(File child) Return a File representing the absolute path of a file in this directory.
static FileFilter	getMatchAllFilesFilter() Returns a filter matching all files.
String[]	getWarnings() Return a list of warnings that have occurred since the last time getWarnings() was called.
int	hashCode() Delegate equality to our File.
boolean	isParentOf(File file) Test whether a File represents the name of a file that is a descendant of the directory.
File[]	listContents(FileFilter filter) Equivalent to listContents(filter, false, false).
File[]	listContents(FileFilter filter, boolean includeDirectories, boolean absolutePaths) List the files in the hierarchy below the directory that have been modified after since.
File	rebaseFromCWD(File file) If possible, convert a path relative to the current working directory to a path relative to this directory.
List<File>	rebasePath(String path) Rebase a whole path by calling #rebaseFile on each of its elements and joining the result.
File	relativeFile(File file, boolean mustBeChild) Convert the supplied file, to a path relative to this directory.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Directory

public Directory()

Constructor that builds a Directory for the current working directory.

Directory

public Directory(File directory)
          throws Directory.DirectoryException

Constructor.

Parameters:

directory - The directory path upon which this Directory operates.

Throws:

Directory.DirectoryException - If the path directory represents a file that exists but is not a directory.

Method Detail

getMatchAllFilesFilter

public static FileFilter getMatchAllFilesFilter()

Returns a filter matching all files.

Returns:

A filter matching all files.

create

public void create()
            throws Directory.DirectoryException

Create the directory if it doesn't exist.

Throws:

Directory.DirectoryException - If the directory could not be created.

getFile

public File getFile()

Get as a File.

Returns:

The File.

getFile

public File getFile(File child)

Return a File representing the absolute path of a file in this directory.

Parameters:

child - Relative file in this directory. If null, the result is equivalent to getFile().

Returns:

The File.

listContents

public File[] listContents(FileFilter filter)

Equivalent to listContents(filter, false, false).

Parameters:

filter - Filter that controls the files that are returned.

Returns:

The list of files. Files are relative to the directory, not absolute. More deeply nested files are later in the list. The list is empty if the directory does not exist.

See Also:

listContents(FileFilter, boolean, boolean)

listContents

public File[] listContents(FileFilter filter,
                  boolean includeDirectories,
                  boolean absolutePaths)

List the files in the hierarchy below the directory that have been modified after since.

Parameters:

filter - Filter that controls the files that are returned.

includeDirectories - Whether to include directories in the returned files. Only directories that match the filter will be returned.

absolutePaths - Whether returned files should be relative to the directory or absolute.

Returns:

The list of files. More deeply nested files are later in the list. The list is empty if the directory does not exist.

deleteContents

public void deleteContents()
                    throws Directory.DirectoryException

Delete the contents of the directory.

Does nothing if the directory does not exist.

Throws:

Directory.DirectoryException - If a file could not be deleted. The contents of the directory are left in an indeterminate state.

See Also:

delete()

delete

public void delete()
            throws Directory.DirectoryException

Delete the directory. This will fail if the directory is not empty.

Throws:

Directory.DirectoryException - If the directory could not be deleted.

See Also:

deleteContents()

rebaseFromCWD

public File rebaseFromCWD(File file)

If possible, convert a path relative to the current working directory to a path relative to this directory. If not possible, return the absolute version of the path.

Parameters:

file - The input path. Relative to the CWD, or absolute.

Returns:

The simplified path.

relativeFile

public File relativeFile(File file,
                boolean mustBeChild)

Convert the supplied file, to a path relative to this directory. The file need not exist.

If file is relative, this directory is considered its base.

Parameters:

file - The file to search for.

mustBeChild - If true and path belongs to another file system; is absolute with a different base path; or is a relative path outside of the directory (../somewhere/else), then null will be returned.

Returns:

A path relative to this directory, or null.

rebasePath

public List<File> rebasePath(String path)

Rebase a whole path by calling #rebaseFile on each of its elements and joining the result.

Parameters:

path - The path.

Returns:

The result.

isParentOf

public boolean isParentOf(File file)

Test whether a File represents the name of a file that is a descendant of the directory.

Parameters:

file - File to test.

Returns:

boolean => file is a descendant.

copyTo

public void copyTo(Directory target,
          boolean incremental)
            throws IOException

Copy contents of the directory to the target directory.

Parameters:

target - Target directory.

incremental - true => copy newer files to the directory. false => overwrite the target directory.

Throws:

IOException - If a file could not be copied. The contents of the target directory are left in an indeterminate state.

getWarnings

public String[] getWarnings()

Return a list of warnings that have occurred since the last time getWarnings() was called.

Returns:

The list of warnings.

hashCode

public int hashCode()

Delegate equality to our File.

Overrides:

hashCode in class Object

Returns:

The hash code.

equals

public boolean equals(Object o)

Delegate equality to our File.

Overrides:

equals in class Object

Parameters:

o - Object to compare.

Returns:

true => equal.