java.lang.Object
org.apache.tools.ant.taskdefs.optional.ssh.Directory

public class Directory extends Object
A helper object for Scp representing a directory in a file system.
  • Constructor Details

    • Directory

      public Directory(File directory)
      Constructor for a Directory.
      Parameters:
      directory - a directory.
    • Directory

      public Directory(File directory, Directory parent)
      Constructor for a Directory.
      Parameters:
      directory - a directory
      parent - a parent Directory
  • Method Details

    • addDirectory

      public void addDirectory(Directory directory)
      Add a directory to the child directories.
      Parameters:
      directory - a Directory
    • addFile

      public void addFile(File file)
      Add a file to the list of files.
      Parameters:
      file - a file to add
    • directoryIterator

      public Iterator<Directory> directoryIterator()
      Get an iterator over the child Directories.
      Returns:
      an iterator
    • filesIterator

      public Iterator<File> filesIterator()
      Get an iterator over the files.
      Returns:
      an iterator
    • getParent

      public Directory 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

      public File getDirectory()
      Get the directory file.
      Returns:
      the directory file
    • getChild

      public Directory getChild(File dir)
      Get a child directory of this directory.
      Parameters:
      dir - the directory to look for
      Returns:
      the child directory, or null if not found
    • equals

      public boolean equals(Object obj)
      The equality method. This checks if the directory field is the same.
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare to
      Returns:
      true if this object has an equal directory field as the other object
    • hashCode

      public int hashCode()
      The hashcode method.
      Overrides:
      hashCode in class Object
      Returns:
      the hash code of the directory field
    • getPath

      public String[] getPath()
      Get the path components of this directory.
      Returns:
      the path components as an array of strings.
    • getPath

      public static String[] getPath(String thePath)
      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