Class TrailerPath

java.lang.Object

com.itextpdf.kernel.utils.objectpathitems.ObjectPath

com.itextpdf.kernel.utils.objectpathitems.TrailerPath

public final class TrailerPath
extends ObjectPath

Direct path item (see ObjectPath), which describes transition to the trailer entry which value is now a currently comparing direct object.

Field Summary

Fields

Modifier and Type	Field	Description
private final PdfDocument	cmpDocument
private static final String	INITIAL_LINE
private final PdfDocument	outDocument

Fields inherited from class ObjectPath

path

Constructor Summary

Constructors

Constructor	Description
TrailerPath(PdfDocument cmpDoc, PdfDocument outDoc)	Creates new TrailerPath instance with corresponding base objects in two documents.
TrailerPath(PdfDocument cmpDoc, PdfDocument outDoc, Stack<LocalPathItem> path)	Creates new TrailerPath instance with corresponding base objects in two documents.
TrailerPath(TrailerPath trailerPath)	Creates new TrailerPath instance from another TrailerPath object, passed as argument.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Method returns true if this TrailerPath instance equals to the passed object.
PdfDocument	getCmpDocument()	Method returns current cmp PdfDocument object.
PdfDocument	getOutDocument()	Method returns current out PdfDocument object.
int	hashCode()	Method returns a hash code of this TrailerPath instance.
String	toString()	Method returns a string representation of this TrailerPath instance.
Node	toXmlNode(Document document)	Creates xml node that describes this TrailerPath instance.

Methods inherited from class ObjectPath

getBaseCmpObject, getBaseOutObject, getIndirectPath, getLocalPath, isComparing, pop, pushArrayItemToPath, pushDictItemToPath, pushOffsetToPath, resetDirectPath

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

outDocument

private final PdfDocument outDocument

cmpDocument

private final PdfDocument cmpDocument

INITIAL_LINE

private static final String INITIAL_LINE

See Also:

• Constant Field Values

Constructor Details

TrailerPath

public TrailerPath(PdfDocument cmpDoc,
 PdfDocument outDoc)

Creates new TrailerPath instance with corresponding base objects in two documents.

Parameters:

cmpDoc - base object in the cmp document

outDoc - base object in the out document

TrailerPath

public TrailerPath(TrailerPath trailerPath)

Creates new TrailerPath instance from another TrailerPath object, passed as argument.

Parameters:

trailerPath - TrailerPath to create new instance from

TrailerPath

public TrailerPath(PdfDocument cmpDoc,
 PdfDocument outDoc,
 Stack<LocalPathItem> path)

Creates new TrailerPath instance with corresponding base objects in two documents.

Parameters:

cmpDoc - base object in the cmp document

outDoc - base object in the out document

path - local path that denotes sequence of the path items from base object to the comparing direct object

Method Details

getOutDocument

public PdfDocument getOutDocument()

Method returns current out PdfDocument object.

Returns:

current out PdfDocument object.

getCmpDocument

public PdfDocument getCmpDocument()

Method returns current cmp PdfDocument object.

Returns:

current cmp PdfDocument object.

toXmlNode

public Node toXmlNode(Document document)

Creates xml node that describes this TrailerPath instance.

Overrides:

toXmlNode in class ObjectPath

Parameters:

document - xml document, to which this xml node will be added.

Returns:

xml node describing this TrailerPath instance.

toString

public String toString()

Method returns a string representation of this TrailerPath instance.

Overrides:

toString in class ObjectPath

Returns:

a string representation of this TrailerPath instance.

hashCode

public int hashCode()

Method returns a hash code of this TrailerPath instance.

Overrides:

hashCode in class ObjectPath

Returns:

a int hash code of this TrailerPath instance.

equals

public boolean equals(Object obj)

Method returns true if this TrailerPath instance equals to the passed object.

Overrides:

equals in class ObjectPath

Returns:

true - if this TrailerPath instance equals to the passed object.