NameTree Class Documentation

classNameTree

Namespace:com::datalogics::PDFL

Detailed Description

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.

Referenced by

DocumentNameTree

Constructor & Destructor Documentation

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

enumEntries

voidenumEntries(PDFObjectEnumProcenumProc)

Parameters

enumProc: PDFObjectEnumProc

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.

Returns:

void

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.

equals

booleanequals(Objectrhs)

Parameters

rhs: Object

Returns:

boolean

finalize

voidfinalize()

Returns:

void

get

PDFObjectget(PDFStringkey)

Parameters

key: PDFString

The name of the PDFObject to get from the tree.

Returns:

- The PDFObject value corresponding to the supplied key

Retrieves an entry from this NameTree.

getPDFDict

PDFDictgetPDFDict()

Returns:

PDFDict of the NameTree

Return the PDFDict of this NameTree.

put

voidput(PDFStringkey, PDFObjectvalue)

Parameters

key: PDFString

The name of the PDFObject to put in the tree.

value: PDFObject

The PDFObject to be associated with key.

Returns:

void

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

remove

voidremove(PDFStringkey)

Parameters

key: PDFString

The name of the PDFObject to remove from the tree.

Returns:

void

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

sameTypeEquals

booleansameTypeEquals(NameTreearg0)

Parameters

arg0: NameTree

Returns:

boolean