|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hpsf.Property
org.apache.poi.hpsf.MutableProperty
org.apache.poi.hpsf.CustomProperty
public class 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.
| Field Summary |
|---|
| Fields inherited from class org.apache.poi.hpsf.Property |
|---|
id, type, value |
| Constructor Summary | |
|---|---|
CustomProperty()
Creates an empty CustomProperty. |
|
CustomProperty(Property property)
Creates a CustomProperty without a name by copying the
underlying Property' attributes. |
|
CustomProperty(Property property,
java.lang.String name)
Creates a CustomProperty with a name. |
|
| Method Summary | |
|---|---|
boolean |
equalsContents(java.lang.Object o)
Compares two custom properties for equality. |
java.lang.String |
getName()
Gets the property's name. |
int |
hashCode()
|
void |
setName(java.lang.String name)
Sets the property's name. |
| Methods inherited from class org.apache.poi.hpsf.MutableProperty |
|---|
setID, setType, setValue, write |
| Methods inherited from class org.apache.poi.hpsf.Property |
|---|
equals, getID, getSize, getType, getValue, readDictionary, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public CustomProperty()
Creates an empty CustomProperty. The set methods must be
called to make it usable.
public CustomProperty(Property property)
Creates a CustomProperty without a name by copying the
underlying Property' attributes.
property - the property to copy
public CustomProperty(Property property,
java.lang.String name)
Creates a CustomProperty with a name.
property - This property's attributes are copied to the new custom
property.name - The new custom property's name.| Method Detail |
|---|
public java.lang.String getName()
Gets the property's name.
public void setName(java.lang.String name)
Sets the property's name.
name - The name to set.public boolean equalsContents(java.lang.Object o)
Compares two custom properties for equality. The method returns
true if all attributes of the two custom properties are
equal.
o - The custom property to compare with.
true if both custom properties are equal, else
false.AbstractSet.equals(java.lang.Object)public int hashCode()
hashCode in class PropertyAbstractSet.hashCode()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||