com.datalogics.PDFL

Class NameTree

java.lang.Object

com.datalogics.PDFL.NameTree

public class NameTree
extends java.lang.Object

The name tree is a common data structure in PDF files. A name tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary.

A name tree uses keys that are character strings to map to data objects. The strings can use a standard coding format, such as Unicode, are sorted in order in the data structure, and can be associated with any type of object.

Constructor Summary

Constructors

Constructor and Description
NameTree(Document doc)

Method Summary

Modifier and Type	Method and Description
void	delete()
void	enumEntries(PDFObjectEnumProc enumProc) Enumerates all the entries of this NameTree.
boolean	equals(java.lang.Object rhs)
PDFObject	get(PDFString key) Retrieves an entry from this NameTree.
PDFDict	getPDFDict() Return the PDFDict of this NameTree.
void	put(PDFString key, PDFObject value) Puts a new entry in this NameTree.
void	remove(PDFString key) Removes the specified PDFObject from this NameTree.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NameTree

public NameTree(Document doc)

Method Detail

delete

public void delete()

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

put

public void put(PDFString key,
                PDFObject value)

Puts a new entry in this NameTree. If an entry with this name is already in the tree, it is replaced.

Parameters:

key - The name of the PDFObject to put in the tree.

value - The PDFObject to be associated with key.

get

public PDFObject get(PDFString key)

Retrieves an entry from this NameTree.

Parameters:

key - The name of the PDFObject to get from the tree.

Returns:

- The PDFObject value corresponding to the supplied key

remove

public void remove(PDFString key)

Removes the specified PDFObject from this NameTree. It does nothing if no PDFObject of that name exists in this NameTree.

Parameters:

key - The name of the PDFObject to remove from the tree.

enumEntries

public void enumEntries(PDFObjectEnumProc enumProc)

Enumerates all the entries of this NameTree.

This method does not enumerate invalid objects, which include objects that are defined as null, objects that are not defined at all (those having no cross-reference entry), and objects that are on the free list.

This re-raises any exception that enumProc raises.

Parameters:

enumProc - A user-supplied callback to call for each indirect object in dP. Enumeration ends when enumProc returns false or all indirect objects have been enumerated. The value parameter returned in enumProc is always null.

getPDFDict

public PDFDict getPDFDict()

Return the PDFDict of this NameTree.

Returns:

PDFDict of the NameTree