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

public Class PDDefaultAttributeObject

extends PDAttributeObject
Class Inheritance
Imports
java.util.ArrayList, .Iterator, .List, org.apache.pdfbox.cos.COSBase, .COSDictionary, .COSName
A default attribute object.
Author
Johannes Koch

Constructor Summary

AccessConstructor and Description
public
PDDefaultAttributeObject()

Default constructor.

public
PDDefaultAttributeObject(COSDictionary
the dictionary
dictionary)

Creates a default attribute object with a given dictionary.

Method Summary

Modifier and TypeMethod and Description
public List<String>

Returns:

the attribute names
getAttributeNames()

Gets the attribute names.

public COSBase

Returns:

the attribute value for a given name
getAttributeValue(String
the given attribute name
attrName)

Gets the attribute value for a given name.

protected COSBase

Returns:

the attribute value for a given name
getAttributeValue(String
the given attribute name
attrName, COSBase
the default value
defaultValue)

Gets the attribute value for a given name.

public void
setAttribute(String
the attribute name
attrName, COSBase
the attribute value
attrValue)

Sets an attribute.

public String
toString()

Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.toString.

Returns a string representation of the object.

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject:
arrayToStringarrayToStringcreategetOwnerisEmptynotifyChangedpotentiallyNotifyChangedsetOwnersetStructureElement

Constructor Detail

PDDefaultAttributeObjectback to summary
public PDDefaultAttributeObject()

Default constructor.

PDDefaultAttributeObjectback to summary
public PDDefaultAttributeObject(COSDictionary dictionary)

Creates a default attribute object with a given dictionary.

Parameters
dictionary:COSDictionary

the dictionary

Method Detail

getAttributeNamesback to summary
public List<String> getAttributeNames()

Gets the attribute names.

Returns:List<String>

the attribute names

getAttributeValueback to summary
public COSBase getAttributeValue(String attrName)

Gets the attribute value for a given name.

Parameters
attrName:String

the given attribute name

Returns:COSBase

the attribute value for a given name

getAttributeValueback to summary
protected COSBase getAttributeValue(String attrName, COSBase defaultValue)

Gets the attribute value for a given name.

Parameters
attrName:String

the given attribute name

defaultValue:COSBase

the default value

Returns:COSBase

the attribute value for a given name

setAttributeback to summary
public void setAttribute(String attrName, COSBase attrValue)

Sets an attribute.

Parameters
attrName:String

the attribute name

attrValue:COSBase

the attribute value

toStringback to summary
public String toString()

Overrides org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject.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