Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

public Class PDUserProperty

extends PDDictionaryWrapper
Class Inheritance
Imports
org.apache.pdfbox.cos.COSBase, .COSDictionary, .COSName, org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
A user property.
Author
Johannes Koch

Field Summary

Modifier and TypeField and Description
private final PDUserAttributeObject
userAttributeObject

Constructor Summary

AccessConstructor and Description
public
PDUserProperty(PDUserAttributeObject
the user attribute object
userAttributeObject)

Creates a new user property.

public
PDUserProperty(COSDictionary
the dictionary
dictionary, PDUserAttributeObject
the user attribute object
userAttributeObject)

Creates a user property with a given dictionary.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper.equals.

Indicates whether some other object is "equal to" this one.

public String

Returns:

the string for the property value
getFormattedValue()

Returns the string for the property value.

public String

Returns:

the property name
getName()

Returns the property name.

public COSBase

Returns:

the property value
getValue()

Returns the property value.

public int
hashCode()

Overrides org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper.hashCode.

Returns a hash code value for this object.

private boolean

Returns:

true if the entry is changed, false otherwise
isEntryChanged(Object
old entry
oldEntry, Object
new entry
newEntry)

Is the value changed?

public boolean

Returns:

true if the property shall be hidden, false otherwise
isHidden()

Shall the property be hidden?

private void
potentiallyNotifyChanged(Object
old entry
oldEntry, Object
new entry
newEntry)

Notifies the user attribute object if the user property is changed.

public void
setFormattedValue(String
the string for the property value
formattedValue)

Sets the string for the property value.

public void
setHidden(boolean
true if the property shall be hidden, false otherwise
hidden)

Specifies whether the property shall be hidden.

public void
setName(String
the property name
name)

Sets the property name.

public void
setValue(COSBase
the property value
value)

Sets the property value.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper:
getCOSObject

Field Detail

userAttributeObjectback to summary
private final PDUserAttributeObject userAttributeObject

Constructor Detail

PDUserPropertyback to summary
public PDUserProperty(PDUserAttributeObject userAttributeObject)

Creates a new user property.

Parameters
userAttributeObject:PDUserAttributeObject

the user attribute object

PDUserPropertyback to summary
public PDUserProperty(COSDictionary dictionary, PDUserAttributeObject userAttributeObject)

Creates a user property with a given dictionary.

Parameters
dictionary:COSDictionary

the dictionary

userAttributeObject:PDUserAttributeObject

the user attribute object

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getFormattedValueback to summary
public String getFormattedValue()

Returns the string for the property value.

Returns:String

the string for the property value

getNameback to summary
public String getName()

Returns the property name.

Returns:String

the property name

getValueback to summary
public COSBase getValue()

Returns the property value.

Returns:COSBase

the property value

hashCodeback to summary
public int hashCode()

Overrides org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isEntryChangedback to summary
private boolean isEntryChanged(Object oldEntry, Object newEntry)

Is the value changed?

Parameters
oldEntry:Object

old entry

newEntry:Object

new entry

Returns:boolean

true if the entry is changed, false otherwise

isHiddenback to summary
public boolean isHidden()

Shall the property be hidden?

Returns:boolean

true if the property shall be hidden, false otherwise

potentiallyNotifyChangedback to summary
private void potentiallyNotifyChanged(Object oldEntry, Object newEntry)

Notifies the user attribute object if the user property is changed.

Parameters
oldEntry:Object

old entry

newEntry:Object

new entry

setFormattedValueback to summary
public void setFormattedValue(String formattedValue)

Sets the string for the property value.

Parameters
formattedValue:String

the string for the property value

setHiddenback to summary
public void setHidden(boolean hidden)

Specifies whether the property shall be hidden.

Parameters
hidden:boolean

true if the property shall be hidden, false otherwise

setNameback to summary
public void setName(String name)

Sets the property name.

Parameters
name:String

the property name

setValueback to summary
public void setValue(COSBase value)

Sets the property value.

Parameters
value:COSBase

the property value

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

Annotations
@Override