com.ibm.are.common
Class DirectoryTreeItem

java.lang.Object
  extended by java.io.File
      extended by com.ibm.are.common.DirectoryTreeItem
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable

public class DirectoryTreeItem
extends java.io.File
implements java.lang.Comparable

The DirectoryTreeItem class represents a single item in a directory tree.

Version:
1.0
Author:
IBM
See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
protected  int nestingLevel
          The level within the directory tree where the item is located or, said another way, how deep within the tree the item is.
 
Fields inherited from class java.io.File
pathSeparator, pathSeparatorChar, separator, separatorChar
 
Constructor Summary
DirectoryTreeItem(java.io.File path, int level)
          Constructs a DirectoryTreeItem object with the specified path name
DirectoryTreeItem(java.io.File parent, java.lang.String child)
          Constructs a DirectoryTreeItem object with the specified parent and child path
DirectoryTreeItem(java.lang.String pathname)
          Constructs a DirectoryTreeItem object with the specified path name
DirectoryTreeItem(java.lang.String parent, java.lang.String child)
          Constructs a DirectoryTreeItem object with the specified parent and child path
DirectoryTreeItem(java.net.URI uri)
          Constructs a DirectoryTreeItem object with the specified URI
 
Method Summary
 int getNestingLevel()
          Retrieves the nesting level (depth) of the directory tree item
 void setNestingLevel(int nestingLevel)
          Sets the nesting level (depth) of the directory tree item
 
Methods inherited from class java.io.File
canExecute, canRead, canWrite, compareTo, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toString, toURI, toURL
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values

nestingLevel

protected int nestingLevel
The level within the directory tree where the item is located or, said another way, how deep within the tree the item is.

Constructor Detail

DirectoryTreeItem

public DirectoryTreeItem(java.lang.String pathname)
Constructs a DirectoryTreeItem object with the specified path name

Parameters:
pathname - The fully qualified path to the directory tree item

DirectoryTreeItem

public DirectoryTreeItem(java.io.File path,
                         int level)
Constructs a DirectoryTreeItem object with the specified path name

Parameters:
path - The fully qualified path to the directory tree item
level - The level within the directory tree where the item is located

DirectoryTreeItem

public DirectoryTreeItem(java.net.URI uri)
Constructs a DirectoryTreeItem object with the specified URI

Parameters:
uri - The fully qualified path to the directory tree item

DirectoryTreeItem

public DirectoryTreeItem(java.lang.String parent,
                         java.lang.String child)
Constructs a DirectoryTreeItem object with the specified parent and child path

Parameters:
parent - The parent path
child - The child path
See Also:
File.File(String, String)

DirectoryTreeItem

public DirectoryTreeItem(java.io.File parent,
                         java.lang.String child)
Constructs a DirectoryTreeItem object with the specified parent and child path

Parameters:
parent - The parent path
child - The child path
See Also:
File.File(File, String)
Method Detail

getNestingLevel

public int getNestingLevel()
Retrieves the nesting level (depth) of the directory tree item

Returns:
The nesting level (depth) of the directory tree item

setNestingLevel

public void setNestingLevel(int nestingLevel)
Sets the nesting level (depth) of the directory tree item

Parameters:
nestingLevel - the nesting level