Apache PDFBox 3.0.4 · org.apache.pdfbox.pdfparser.xref.NormalXReference

Modifier and Type	Field and Description
private final long	byteOffset
private final COSObjectKey	key
private final COSBase	object
private final boolean	objectStream

Constructor Summary

Access	Constructor and Description
public	NormalXReference(long The byte offset of the `COSObject` in the PDF file. byteOffset, COSObjectKey The `COSObjectKey`, that is represented by this entry. key, COSBase The `COSObject`, that is represented by this entry. object) Prepares a normal reference for the given `COSObject` in a PDF's crossreference stream (`PDFXRefStream`).

Method Summary

Modifier and Type	Method and Description
public long	Returns: The byte offset of the `COSObject` in the PDF file. getByteOffset() Returns the byte offset of the `COSObject` in the PDF file.
public COSBase	Returns: The `COSObject`, that is described by this crossreference stream entry. getObject() Returns the `COSObject`, that is described by this crossreference stream entry.
public COSObjectKey	Returns: The `COSObjectKey` of the object, that is described by this crossreference stream entry. getReferencedKey() Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.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() Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.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() Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.getThirdColumnValue. Returns the value for the third column of the crossreference stream entry.
public boolean	Returns: True, if the referenced object is an object stream. isObjectStream() Returns true, if the referenced object is an object stream.
public String	Returns: A string representation of this crossreference stream entry. toString() Overrides java.lang.Object.toString. Returns a string representation of this crossreference stream entry.

Inherited from org.apache.pdfbox.pdfparser.xref.AbstractXReference:: compareTo getFirstColumnValue getType

Field Detail

byteOffset	back to summary
private final long byteOffset

key	back to summary
private final COSObjectKey key

object	back to summary
private final COSBase object

objectStream	back to summary
private final boolean objectStream

Constructor Detail

NormalXReference back to summary

NormalXReference	back to summary
public NormalXReference(long byteOffset, COSObjectKey key, COSBase object) Prepares a normal reference for the given `COSObject` in a PDF's crossreference stream (`PDFXRefStream`). Parameters byteOffset:long The byte offset of the `COSObject` in the PDF file. key:COSObjectKey The `COSObjectKey`, that is represented by this entry. object:COSBase The `COSObject`, that is represented by this entry.

public NormalXReference(long byteOffset, COSObjectKey key, COSBase object)

Prepares a normal reference for the given COSObject in a PDF's crossreference stream (PDFXRefStream).

Parameters

byteOffset:long: The byte offset of the COSObject in the PDF file.
key:COSObjectKey: The COSObjectKey, that is represented by this entry.
object:COSBase: The COSObject, that is represented by this entry.

Method Detail

getByteOffset back to summary

getByteOffset	back to summary
public long getByteOffset() Returns the byte offset of the `COSObject` in the PDF file. Returns:long The byte offset of the `COSObject` in the PDF file.

public long getByteOffset()

Returns the byte offset of the COSObject in the PDF file.

Returns:long: The byte offset of the COSObject in the PDF file.

getObject back to summary

getObject	back to summary
public COSBase getObject() Returns the `COSObject`, that is described by this crossreference stream entry. Returns:COSBase The `COSObject`, that is described by this crossreference stream entry.

public COSBase getObject()

Returns the COSObject, that is described by this crossreference stream entry.

Returns:COSBase: The COSObject, that is described by this crossreference stream entry.

getReferencedKey back to summary

getReferencedKey	back to summary
public COSObjectKey getReferencedKey() Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.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. Annotations @Override

public COSObjectKey getReferencedKey()

Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.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.

Annotations

@Override

getSecondColumnValue back to summary

getSecondColumnValue	back to summary
public long getSecondColumnValue() Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.getSecondColumnValue. Returns the value for the second column of the crossreference stream entry. (This is byte offset of the `COSObject` in the PDF file - for entries of this type.) Returns:long The value for the second column of the crossreference stream entry. Annotations @Override

public long getSecondColumnValue()

Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.getSecondColumnValue.

Returns the value for the second column of the crossreference stream entry. (This is byte offset of the COSObject in the PDF file - for entries of this type.)

Returns:long

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

Annotations

@Override

getThirdColumnValue back to summary

getThirdColumnValue	back to summary
public long getThirdColumnValue() Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.getThirdColumnValue. Returns the value for the third column of the crossreference stream entry. (This is the generation number of the set `COSObjectKey` - for entries of this type.) Returns:long The value for the third column of the crossreference stream entry. Annotations @Override

public long getThirdColumnValue()

Implements org.apache.pdfbox.pdfparser.xref.XReferenceEntry.getThirdColumnValue.

Returns the value for the third column of the crossreference stream entry. (This is the generation number of the set COSObjectKey - for entries of this type.)

Returns:long

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

Annotations

@Override

isObjectStream	back to summary
public boolean isObjectStream() Returns true, if the referenced object is an object stream. Returns:boolean True, if the referenced object is an object stream.

isObjectStream

back to summary

public boolean isObjectStream()

Returns true, if the referenced object is an object stream.

Returns:boolean: True, if the referenced object is an object stream.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this crossreference stream entry. Returns:String A string representation of this crossreference stream entry. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this crossreference stream entry.

Returns:String

A string representation of this crossreference stream entry.

Annotations

@Override

public Class NormalXReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail