Package org.apache.pdfbox.pdfparser.xref
Interface XReferenceEntry
-
- All Superinterfaces:
java.lang.Comparable<XReferenceEntry>
- All Known Implementing Classes:
AbstractXReference,FreeXReference,NormalXReference,ObjectStreamXReference
public interface XReferenceEntry extends java.lang.Comparable<XReferenceEntry>
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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description longgetFirstColumnValue()Returns the value for the first column of the crossreference stream entry.COSObjectKeygetReferencedKey()Returns theCOSObjectKeyof the object, that is described by this crossreference stream entry.longgetSecondColumnValue()Returns the value for the second column of the crossreference stream entry.longgetThirdColumnValue()Returns the value for the third column of the crossreference stream entry.XReferenceTypegetType()Returns theXReferenceTypeof this crossreference stream entry.
-
-
-
Method Detail
-
getType
XReferenceType getType()
Returns theXReferenceTypeof this crossreference stream entry.- Returns:
- The
XReferenceTypeof this crossreference stream entry.
-
getReferencedKey
COSObjectKey getReferencedKey()
Returns theCOSObjectKeyof the object, that is described by this crossreference stream entry.- Returns:
- The
COSObjectKeyof the object, that is described by this crossreference stream entry.
-
getFirstColumnValue
long getFirstColumnValue()
Returns the value for the first column of the crossreference stream entry. (The numeric representation of this entry'sXReferenceType.)- Returns:
- The value for the first column of the crossreference stream entry.
-
getSecondColumnValue
long getSecondColumnValue()
Returns the value for the second column of the crossreference stream entry. (It's meaning depends on theXReferenceTypeof this entry.)- Returns:
- The value for the second column of the crossreference stream entry.
-
getThirdColumnValue
long getThirdColumnValue()
Returns the value for the third column of the crossreference stream entry. (It's meaning depends on theXReferenceTypeof this entry.)- Returns:
- The value for the third column of the crossreference stream entry.
-
-