Package loci.poi.hpsf
Class CustomProperty
java.lang.Object
loci.poi.hpsf.Property
loci.poi.hpsf.MutableProperty
loci.poi.hpsf.CustomProperty
This class represents custum properties in the document summary
information stream. The difference to normal properties is that custom
properties have an optional name. If the name is not null it
will be maintained in the section's dictionary.
- Since:
- 2006-02-09
- Version:
- $Id$
- Author:
- Rainer Klute <klute@rainer-klute.de>
-
Field Summary
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an emptyCustomProperty.CustomProperty(Property property) Creates aCustomPropertywithout a name by copying the underlyingProperty' attributes.CustomProperty(Property property, String name) Creates aCustomPropertywith a name. -
Method Summary
Methods inherited from class loci.poi.hpsf.MutableProperty
setID, setType, setValue, write
-
Constructor Details
-
CustomProperty
public CustomProperty()Creates an empty
CustomProperty. The set methods must be called to make it usable. -
CustomProperty
Creates a
CustomPropertywithout a name by copying the underlyingProperty' attributes.- Parameters:
property- the property to copy
-
CustomProperty
Creates a
CustomPropertywith a name.- Parameters:
property- This property's attributes are copied to the new custom property.name- The new custom property's name.
-
-
Method Details
-
getName
Gets the property's name.
- Returns:
- the property's name.
-
setName
Sets the property's name.
- Parameters:
name- The name to set.
-
equalsContents
Compares two custom properties for equality. The method returns
trueif all attributes of the two custom properties are equal.- Parameters:
o- The custom property to compare with.- Returns:
trueif both custom properties are equal, elsefalse.- See Also:
-
hashCode
public int hashCode()
-