Class Directory
java.lang.Object
org.apache.tools.ant.taskdefs.optional.ssh.Directory
A helper object for Scp representing a directory in a file system.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDirectory
(Directory directory) Add a directory to the child directories.void
Add a file to the list of files.Get an iterator over the child Directories.boolean
The equality method.Get an iterator over the files.int
fileSize()
Get the number of files in the files attribute.Get a child directory of this directory.Get the directory file.Get the parent Directory.String[]
getPath()
Get the path components of this directory.static String[]
Convert a file path to an array of path components.int
hashCode()
The hashcode method.boolean
isRoot()
Is this a root Directory?
-
Constructor Details
-
Directory
Constructor for a Directory.- Parameters:
directory
- a directory.
-
Directory
Constructor for a Directory.- Parameters:
directory
- a directoryparent
- a parent Directory
-
-
Method Details
-
addDirectory
Add a directory to the child directories.- Parameters:
directory
- a Directory
-
addFile
Add a file to the list of files.- Parameters:
file
- a file to add
-
directoryIterator
Get an iterator over the child Directories.- Returns:
- an iterator
-
filesIterator
Get an iterator over the files.- Returns:
- an iterator
-
getParent
Get the parent Directory.- Returns:
- the parent Directory.
-
isRoot
public boolean isRoot()Is this a root Directory?- Returns:
- true if there is no parent Directory
-
getDirectory
Get the directory file.- Returns:
- the directory file
-
getChild
Get a child directory of this directory.- Parameters:
dir
- the directory to look for- Returns:
- the child directory, or null if not found
-
equals
The equality method. This checks if the directory field is the same. -
hashCode
public int hashCode()The hashcode method. -
getPath
Get the path components of this directory.- Returns:
- the path components as an array of strings.
-
getPath
Convert a file path to an array of path components. This uses File.separator to split the file path string.- Parameters:
thePath
- the file path string to convert- Returns:
- an array of path components
-
fileSize
public int fileSize()Get the number of files in the files attribute.- Returns:
- the number of files
-