Top Description Fields Constructors Methods
org.apache.poi.poifs.filesystem

public Class DocumentDescriptor

extends Object
Class Inheritance

Class DocumentDescriptor

Field Summary

Modifier and TypeField and Description
private int
private String
private POIFSDocumentPath

Constructor Summary

AccessConstructor and Description
public
DocumentDescriptor(final POIFSDocumentPath
the Document path
path
,
final String
the Document name
name
)

Trivial constructor

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the object is equal to this object
equals
(final Object
the object we're checking equality for
o
)

Overrides java.lang.Object.equals.

equality.

public int

Returns:

hashcode
hashCode
()

Overrides java.lang.Object.hashCode.

calculate and return the hashcode

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

hashcodeback to summary
private int hashcode
nameback to summary
private String name
pathback to summary
private POIFSDocumentPath path

Constructor Detail

DocumentDescriptorback to summary
public DocumentDescriptor(final POIFSDocumentPath path, final String name)

Trivial constructor

Parameters
path:POIFSDocumentPath

the Document path

name:String

the Document name

Method Detail

equalsback to summary
public boolean equals(final Object o)

Overrides java.lang.Object.equals.

equality. Two DocumentDescriptor instances are equal if they have equal paths and names

Parameters
o:Object

the object we're checking equality for

Returns:boolean

true if the object is equal to this object

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

calculate and return the hashcode

Returns:int

hashcode

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object