Package loci.poi.poifs.filesystem
Class POIFSDocumentPath
- java.lang.Object
-
- loci.poi.poifs.filesystem.POIFSDocumentPath
-
public class POIFSDocumentPath extends Object
Class POIFSDocumentPath- Version:
- %I%, %G%
- Author:
- Marc Johnson (mjohnson at apache dot org)
-
-
Constructor Summary
Constructors Constructor Description POIFSDocumentPath()
simple constructor for the path of a document that is in the root of the POIFSFileSystem.POIFSDocumentPath(String[] components)
constructor for the path of a document that is not in the root of the POIFSFileSystemPOIFSDocumentPath(POIFSDocumentPath path, String[] components)
constructor that adds additional subdirectories to an existing path
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
equality.String
getComponent(int n)
get the specified componentPOIFSDocumentPath
getParent()
Returns the path's parent ornull
if this path is the root path.int
hashCode()
calculate and return the hashcodeint
length()
String
toString()
Returns a string representation of the path.
-
-
-
Constructor Detail
-
POIFSDocumentPath
public POIFSDocumentPath(String[] components) throws IllegalArgumentException
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 in the directory hierarchy of the the document -- the first string must be the name of a directory in the root of the POIFSFileSystem, and every Nth (for N > 1) string thereafter must be the name of a directory in the directory identified by the (N-1)th string.If the components parameter is null or has zero length, the POIFSDocumentPath is appropriate for a document that is in the root of a POIFSFileSystem
- Throws:
IllegalArgumentException
- if any of the elements in the components parameter are null or have zero length
-
POIFSDocumentPath
public POIFSDocumentPath()
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
constructor that adds additional subdirectories to an existing path- Parameters:
path
- the existing pathcomponents
- the additional subdirectory names to be added- Throws:
IllegalArgumentException
- if any of the Strings in components is null or zero length
-
-
Method Detail
-
equals
public boolean equals(Object o)
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
-
hashCode
public int hashCode()
calculate and return the hashcode
-
length
public int length()
- Returns:
- the number of components
-
getComponent
public String getComponent(int n) throws ArrayIndexOutOfBoundsException
get the specified component- Parameters:
n
- which component (0 ... length() - 1)- Returns:
- the nth component;
- Throws:
ArrayIndexOutOfBoundsException
- if n < 0 or n >= length()
-
getParent
public POIFSDocumentPath getParent()
Returns the path's parent or
null
if this path is the root path.- Returns:
- path of parent, or null if this path is the root path
- Since:
- 2002-01-24
-
-