Package org.apache.poi.hpsf
Class CustomProperty
java.lang.Object
org.apache.poi.hpsf.Property
org.apache.poi.hpsf.CustomProperty
This class represents custom 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.-
Field Summary
Fields inherited from class org.apache.poi.hpsf.Property
DEFAULT_CODEPAGE
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an emptyCustomProperty
.CustomProperty
(Property property) Creates aCustomProperty
without a name by copying the underlyingProperty
' attributes.CustomProperty
(Property property, String name) Creates aCustomProperty
with a name. -
Method Summary
-
Constructor Details
-
CustomProperty
public CustomProperty()Creates an emptyCustomProperty
. The set methods must be called to make it usable. -
CustomProperty
Creates aCustomProperty
without a name by copying the underlyingProperty
' attributes.- Parameters:
property
- the property to copy
-
CustomProperty
Creates aCustomProperty
with 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 returnstrue
if all attributes of the two custom properties are equal.- Parameters:
o
- The custom property to compare with.- Returns:
true
if both custom properties are equal, elsefalse
.- See Also:
-
hashCode
public int hashCode() -
equals
Description copied from class:Property
Compares two properties.Please beware that a property with ID == 0 is a special case: It does not have a type, and its value is the section's dictionary. Another special case are strings: Two properties may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;
-