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

Modifier and Type	Field and Description
private final COSObjectKey	key
private final long	nextFreeObject
public static final FreeXReference	NULL_ENTRY

Constructor Summary

Access	Constructor and Description
public	FreeXReference(COSObjectKey The key, that shall be set as the free reference of the document. key, long The object number of the next free object. nextFreeObject) Sets the given `COSObjectKey` as a free reference in a PDF's crossreference stream (`PDFXRefStream`).

Method Summary

Modifier and Type	Method and Description
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 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

key	back to summary
private final COSObjectKey key

nextFreeObject	back to summary
private final long nextFreeObject

NULL_ENTRY	back to summary
public static final FreeXReference NULL_ENTRY

Constructor Detail

FreeXReference back to summary

FreeXReference	back to summary
public FreeXReference(COSObjectKey key, long nextFreeObject) Sets the given `COSObjectKey` as a free reference in a PDF's crossreference stream (`PDFXRefStream`). Parameters key:COSObjectKey The key, that shall be set as the free reference of the document. nextFreeObject:long The object number of the next free object.

public FreeXReference(COSObjectKey key, long nextFreeObject)

Sets the given COSObjectKey as a free reference in a PDF's crossreference stream (PDFXRefStream).

Parameters

key:COSObjectKey: The key, that shall be set as the free reference of the document.
nextFreeObject:long: The object number of the next free object.

Method Detail

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 the object number of the set next free `COSObjectKey` - 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 the object number of the set next free COSObjectKey - 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 next free `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 next free COSObjectKey - for entries of this type.)

Returns:long

The value for the third column of the 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

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 FreeXReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail