|
| |
|
| java.lang.Object
 org.apache.poi.poifs.filesystem.POIFSDocumentPath
| POIFSDocumentPath | | public class POIFSDocumentPath (Code) | | Class POIFSDocumentPath
author:
Marc Johnson (mjohnson at apache dot org)
version:
%I%, %G% |
| POIFSDocumentPath | | public POIFSDocumentPath(String[] components) throws IllegalArgumentException(Code) | | constructor for the path of a document that is not in the root
of the POIFSFileSystem
Parameters:
components - the Strings making up the path to a document.The Strings must be ordered as they appear inthe directory hierarchy of the the document-- the first string must be the name of adirectory in the root of the POIFSFileSystem,and every Nth (for N > 1) string thereaftermust be the name of a directory in thedirectory identified by the (N-1)th string.If the components parameter is null or haszero length, the POIFSDocumentPath isappropriate for a document that is in theroot of a POIFSFileSystem
exception:
IllegalArgumentException - if any of the elements inthe components parameterare null or have zerolength |
| POIFSDocumentPath | | public POIFSDocumentPath()(Code) | | simple constructor for the path of a document that is in the
root of the POIFSFileSystem. The constructor that takes an
array of Strings can also be used to create such a
POIFSDocumentPath by passing it a null or empty String array
|
| POIFSDocumentPath | | public POIFSDocumentPath(POIFSDocumentPath path, String[] components) throws IllegalArgumentException(Code) | | constructor that adds additional subdirectories to an existing
path
Parameters:
path - the existing path
Parameters:
components - the additional subdirectory names to be added
exception:
IllegalArgumentException - if any of the Strings incomponents is null or zerolength |
| equals | | public boolean equals(Object o)(Code) | | equality. Two POIFSDocumentPath instances are equal if they
have the same number of component Strings, and if each
component String is equal to its coresponding component String
Parameters:
o - the object we're checking equality for true if the object is equal to this object |
| getParent | | public POIFSDocumentPath getParent()(Code) | | Returns the path's parent or null if this path
is the root path.
since:
2002-01-24 path of parent, or null if this path is the root path |
| hashCode | | public int hashCode()(Code) | | calculate and return the hashcode
hashcode |
| length | | public int length()(Code) | | the number of components |
| toString | | public String toString()(Code) | | Returns a string representation of the path. Components are
separated by the platform-specific file separator.
string representation
since:
2002-01-24 |
|
|
|