org.apache.pdfbox.pdfwriter.compress

Class TraversedCOSElement

java.lang.Object

org.apache.pdfbox.pdfwriter.compress.TraversedCOSElement

public class TraversedCOSElement
extends Object

An instance of this class represents a traversed element of a COS tree. It allows to determine the position of a COSBase in a hierarchical COS structure and provides the means to further traverse and evaluate it's descendants.

Author:

Christian Appl

Constructor Summary

Constructors

Constructor and Description
TraversedCOSElement(COSBase currentObject) Construct a fresh entrypoint for the traversal of a hierarchical COS structure, beginning with the given COSBase.

Method Summary

Modifier and Type	Method and Description
TraversedCOSElement	appendTraversedElement(COSBase element) Construct a new traversal node for the given element and append it as a child to the current node.
TraversedCOSElement	findAtCurrentPosition(COSBase object) Searches all known traversed child nodes of the current traversal node for the given COSBase.
List<COSBase>	getAllTraversedObjects() Returns a list of all objects, that have been traversed in the created traversal tree.
COSBase	getCurrentBaseObject() Returns the actual current COSBase of this traversal node.
COSBase	getCurrentObject() Returns the current COSBase of this traversal node.
TraversedCOSElement	getParent() Returns the parent node of the current traversal node.
List<TraversedCOSElement>	getTraversedChildren() Returns all known traversable/traversed children contained by the current traversal node.
List<TraversedCOSElement>	getTraversedElements()
boolean	isPartOfStreamDictionary() Returns true, if the given traversal node has been marked as a part of a COSStream.
void	setPartOfStreamDictionary(boolean partOfStreamDictionary) Set to true, if the given traversal node shall be marked as a part of a COSStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TraversedCOSElement

public TraversedCOSElement(COSBase currentObject)

Construct a fresh entrypoint for the traversal of a hierarchical COS structure, beginning with the given COSBase.

Parameters:

currentObject - The initial COSBase, with which the structure traversal shall begin.

Method Detail

appendTraversedElement

public TraversedCOSElement appendTraversedElement(COSBase element)

Construct a new traversal node for the given element and append it as a child to the current node.

Parameters:

element - The element, that shall be traversed.

Returns:

The resulting traversal node, that has been created.

getCurrentObject

public COSBase getCurrentObject()

Returns the current COSBase of this traversal node.

Returns:

The current COSBase of this traversal node.

getCurrentBaseObject

public COSBase getCurrentBaseObject()

Returns the actual current COSBase of this traversal node. Meaning: If the current traversal node contains a reference to a COSObject, it's actual base object will be returned instead.

Returns:

The actual current COSBase of this traversal node.

getParent

public TraversedCOSElement getParent()

Returns the parent node of the current traversal node.

Returns:

The parent node of the current traversal node.

getTraversedChildren

public List<TraversedCOSElement> getTraversedChildren()

Returns all known traversable/traversed children contained by the current traversal node.

Returns:

All known traversable/traversed children contained by the current traversal node.

getTraversedElements

public List<TraversedCOSElement> getTraversedElements()

findAtCurrentPosition

public TraversedCOSElement findAtCurrentPosition(COSBase object)

Searches all known traversed child nodes of the current traversal node for the given COSBase.

Parameters:

object - The COSBase, that shall be found.

Returns:

The traversal node representing the searched COSBase or null, if such a node can not be found.

getAllTraversedObjects

public List<COSBase> getAllTraversedObjects()

Returns a list of all objects, that have been traversed in the created traversal tree.

Returns:

A list of all objects, that have been traversed in the created traversal tree.

isPartOfStreamDictionary

public boolean isPartOfStreamDictionary()

Returns true, if the given traversal node has been marked as a part of a COSStream.

Returns:

True, if the given traversal node has been marked as a part of a COSStream

setPartOfStreamDictionary

public void setPartOfStreamDictionary(boolean partOfStreamDictionary)

Set to true, if the given traversal node shall be marked as a part of a COSStream.

Parameters:

partOfStreamDictionary - True, if the given traversal node shall be marked as a part of a COSStream