com.itextpdf.kernel.pdf

Class GenericNameTree

java.lang.Object

com.itextpdf.kernel.pdf.GenericNameTree

All Implemented Interfaces:

IPdfNameTreeAccess

Direct Known Subclasses:

PdfNameTree, PdfStructIdTree

public class GenericNameTree
extends Object
implements IPdfNameTreeAccess

Abstract representation of a name tree structure, as used in PDF for various purposes such as the Dests tree, the ID tree of structure elements and the embedded file tree.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericNameTree(PdfDocument pdfDoc) Creates a name tree structure in the current document.

Method Summary

Modifier and Type	Method and Description
void	addEntry(PdfString key, PdfObject value) Add an entry to the name tree.
protected void	addEntry(PdfString key, PdfObject value, Consumer<PdfDocument> onErrorAction) Add an entry to the name tree.
void	addEntry(String key, PdfObject value) Add an entry to the name tree.
PdfDictionary	buildTree() Build a PdfDictionary containing the name tree.
PdfObject	getEntry(PdfString key) Retrieve an entry from the name tree.
PdfObject	getEntry(String key) Retrieve an entry from the name tree.
protected LinkedHashMap<PdfString,PdfObject>	getItems()
Set<PdfString>	getKeys() Retrieve the set of keys in the name tree.
boolean	isModified() Check if the tree is modified.
protected static LinkedHashMap<PdfString,PdfObject>	readTree(PdfDictionary dictionary) Read the entries in a name tree structure from a dictionary object into a linked hash map with fixed order.
void	removeEntry(PdfString key) Remove an entry from the name tree.
protected void	setItems(LinkedHashMap<PdfString,PdfObject> items)
void	setModified() Sets the modified flag to true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericNameTree

protected GenericNameTree(PdfDocument pdfDoc)

Creates a name tree structure in the current document.

Parameters:

pdfDoc - the document in which the name tree lives

Method Detail

addEntry

public void addEntry(PdfString key,
                     PdfObject value)

Add an entry to the name tree.

Parameters:

key - key of the entry

value - object to add

addEntry

public void addEntry(String key,
                     PdfObject value)

Add an entry to the name tree.

Parameters:

key - key of the entry

value - object to add

removeEntry

public void removeEntry(PdfString key)

Remove an entry from the name tree.

Parameters:

key - key of the entry

getEntry

public PdfObject getEntry(PdfString key)

Retrieve an entry from the name tree.

Specified by:

getEntry in interface IPdfNameTreeAccess

Parameters:

key - key of entry to retrieve

Returns:

retrieved entry or null if absent

getEntry

public PdfObject getEntry(String key)

Retrieve an entry from the name tree.

Specified by:

getEntry in interface IPdfNameTreeAccess

Parameters:

key - key of entry to retrieve

Returns:

retrieved entry or null if absent

getKeys

public Set<PdfString> getKeys()

Description copied from interface: IPdfNameTreeAccess

Retrieve the set of keys in the name tree.

Specified by:

getKeys in interface IPdfNameTreeAccess

Returns:

set of all keys in the name tree

isModified

public boolean isModified()

Check if the tree is modified.

Returns:

True if the object has been modified, false otherwise.

setModified

public void setModified()

Sets the modified flag to true. It means that the object has been modified.

buildTree

public PdfDictionary buildTree()

Build a PdfDictionary containing the name tree.

Returns:

PdfDictionary containing the name tree

addEntry

protected void addEntry(PdfString key,
                        PdfObject value,
                        Consumer<PdfDocument> onErrorAction)

Add an entry to the name tree.

Parameters:

key - key of the entry

value - object to add

onErrorAction - action to perform if such entry exists

setItems

protected final void setItems(LinkedHashMap<PdfString,PdfObject> items)

getItems

protected final LinkedHashMap<PdfString,PdfObject> getItems()

readTree

protected static LinkedHashMap<PdfString,PdfObject> readTree(PdfDictionary dictionary)

Read the entries in a name tree structure from a dictionary object into a linked hash map with fixed order.

Parameters:

dictionary - a dictionary object

Returns:

a map containing the entries in the tree