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

Modifier and Type	Field and Description
private final COSObjectKey	key
private final COSBase	object
private final int	objectStreamIndex
private final COSObjectKey	parentKey

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	ObjectStreamXReference(int The index of the `COSObject` in the containing object stream. objectStreamIndex, COSObjectKey The `COSObjectKey`, that is represented by this entry. key, COSBase The `COSObject`, that is represented by this entry. object, COSObjectKey The `COSObjectKey` of the object stream, that is containing the object. parentKey) Prepares a object stream entry reference for the given `COSObject` in a PDF's crossreference stream (`PDFXRefStream`).

public

ObjectStreamXReference(int

The index of the COSObject in the containing object stream.

objectStreamIndex, COSObjectKey

The COSObjectKey, that is represented by this entry.

key, COSBase

The COSObject, that is represented by this entry.

object, COSObjectKey

The COSObjectKey of the object stream, that is containing the object.

parentKey)

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

Method Summary

Modifier and Type	Method and Description
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 int	Returns: The index of the `COSObject` in it's containing object stream. getObjectStreamIndex() Returns the index of the `COSObject` in it's containing object stream.
public COSObjectKey	Returns: The `COSObjectKey` of the object stream, that is containing the object. getParentKey() Returns the `COSObjectKey` of the object stream, that is containing the object.
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

object	back to summary
private final COSBase object

objectStreamIndex	back to summary
private final int objectStreamIndex

parentKey	back to summary
private final COSObjectKey parentKey

Constructor Detail

ObjectStreamXReference back to summary

ObjectStreamXReference	back to summary
public ObjectStreamXReference(int objectStreamIndex, COSObjectKey key, COSBase object, COSObjectKey parentKey) Prepares a object stream entry reference for the given `COSObject` in a PDF's crossreference stream (`PDFXRefStream`). Parameters objectStreamIndex:int The index of the `COSObject` in the containing object stream. key:COSObjectKey The `COSObjectKey`, that is represented by this entry. object:COSBase The `COSObject`, that is represented by this entry. parentKey:COSObjectKey The `COSObjectKey` of the object stream, that is containing the object.

public ObjectStreamXReference(int objectStreamIndex, COSObjectKey key, COSBase object, COSObjectKey parentKey)

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

Parameters

objectStreamIndex:int: The index of the COSObject in the containing object stream.
key:COSObjectKey: The COSObjectKey, that is represented by this entry.
object:COSBase: The COSObject, that is represented by this entry.
parentKey:COSObjectKey: The COSObjectKey of the object stream, that is containing the object.

Method Detail

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.

getObjectStreamIndex back to summary

getObjectStreamIndex	back to summary
public int getObjectStreamIndex() Returns the index of the `COSObject` in it's containing object stream. Returns:int The index of the `COSObject` in it's containing object stream.

public int getObjectStreamIndex()

Returns the index of the COSObject in it's containing object stream.

Returns:int: The index of the COSObject in it's containing object stream.

getParentKey back to summary

getParentKey	back to summary
public COSObjectKey getParentKey() Returns the `COSObjectKey` of the object stream, that is containing the object. Returns:COSObjectKey The `COSObjectKey` of the object stream, that is containing the object.

public COSObjectKey getParentKey()

Returns the COSObjectKey of the object stream, that is containing the object.

Returns:COSObjectKey: The COSObjectKey of the object stream, that is containing the object.

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 object number from the `COSObjectKey` of the object stream, that is containing the object represented by this entry - 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 object number from the COSObjectKey of the object stream, that is containing the object represented by this entry - 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 index of the `COSObject` in the containing object stream - 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 index of the COSObject in the containing object stream - 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 ObjectStreamXReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail