NameTree

Overview

NameTree is a class in Aspose.Pdf FOSS for Java.

Mutable map view over a PDF name tree (ISO 32000-1:2008, §7.9.6).

Properties

NameTypeAccessDescription
rootCOSDictionaryReadReturns the underlying root dictionary, or {@code null} if this view
was constructed over a {@code null} root.
emptybooleanReadReturns whether the tree has no entries.

Methods

SignatureDescription
NameTree(root: COSDictionary)Wraps the given root dictionary.
getRoot()COSDictionaryReturns the underlying root dictionary, or {@code null} if this view
was constructed over a {@code null} root.
isEmpty()booleanReturns whether the tree has no entries.
size()intReturns the number of (key, value) pairs in the tree.
get(key: String)COSBaseLooks up a key.
containsKey(key: String)booleanReturns whether the tree contains the given key.
entries()List<Map.Entry<String, COSBase>>Returns all entries in tree order (which, for a conformant tree, is
key-sorted order).
keys()List<String>Returns all keys in tree order.
put(key: String, value: COSBase)COSBaseInserts or replaces a value.
remove(key: String)COSBaseRemoves a key.
clear()Empties the tree: drops all {@code /Kids}, {@code /Limits} and any
{@code /Names} array contents.
entriesUnmodifiable()List<Map.Entry<String, COSBase>>Returns an unmodifiable view of {@link #entries()} for callers that
want a {@link List} interface but no mutation.

See Also