Top Description Methods
org.apache.pdfbox.pdfparser.xref

public Interface XReferenceEntry

extends Comparable<XReferenceEntry>
Known Direct Implementers
org.apache.pdfbox.pdfparser.xref.AbstractXReference
Imports
org.apache.pdfbox.cos.COSObjectKey, org.apache.pdfbox.pdfparser.PDFXRefStream

An implementing class represents an entry, as it can be found in a PDF's crossreference stream (PDFXRefStream). Such an entry shall locate a PDF object/resource in a PDF document.
Author
Christian Appl

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

The value for the first column of the crossreference stream entry.
getFirstColumnValue
()

Returns the value for the first column of the crossreference stream entry.

public COSObjectKey

Returns:

The COSObjectKey of the object, that is described by this crossreference stream entry.
getReferencedKey
()

Returns the COSObjectKey of the object, that is described by this crossreference stream entry.

public long

Returns:

The value for the second column of the crossreference stream entry.
getSecondColumnValue
()

Returns the value for the second column of the crossreference stream entry.

public long

Returns:

The value for the third column of the crossreference stream entry.
getThirdColumnValue
()

Returns the value for the third column of the crossreference stream entry.

public XReferenceType

Returns:

The XReferenceType of this crossreference stream entry.
getType
()

Returns the XReferenceType of this crossreference stream entry.

Inherited from java.lang.Comparable:
compareTo

Method Detail

getFirstColumnValueback to summary
public long getFirstColumnValue()

Returns the value for the first column of the crossreference stream entry. (The numeric representation of this entry's XReferenceType.)

Returns:long

The value for the first column of the crossreference stream entry.

getReferencedKeyback to summary
public COSObjectKey getReferencedKey()

Returns the COSObjectKey of the object, that is described by this crossreference stream entry.

Returns:COSObjectKey

The COSObjectKey of the object, that is described by this crossreference stream entry.

getSecondColumnValueback to summary
public long getSecondColumnValue()

Returns the value for the second column of the crossreference stream entry. (It's meaning depends on the XReferenceType of this entry.)

Returns:long

The value for the second column of the crossreference stream entry.

getThirdColumnValueback to summary
public long getThirdColumnValue()

Returns the value for the third column of the crossreference stream entry. (It's meaning depends on the XReferenceType of this entry.)

Returns:long

The value for the third column of the crossreference stream entry.

getTypeback to summary
public XReferenceType getType()

Returns the XReferenceType of this crossreference stream entry.

Returns:XReferenceType

The XReferenceType of this crossreference stream entry.