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

public abstract Class AbstractXReference

extends Object
implements XReferenceEntry
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdfparser.xref.XReferenceEntry, java.lang.Comparable
Known Direct Subclasses
org.apache.pdfbox.pdfparser.xref.FreeXReference, org.apache.pdfbox.pdfparser.xref.NormalXReference, org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Imports
org.apache.pdfbox.pdfparser.PDFXRefStream
An extending 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

Field Summary

Modifier and TypeField and Description
private final XReferenceType
type

Constructor Summary

AccessConstructor and Description
protected
AbstractXReference(XReferenceType
The XReferenceType of the crossreference stream entry.
type)

Creates a crossreference stream entry of the given XReferenceType.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
compareTo(XReferenceEntry
the object to be compared.
xReferenceEntry)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.

public long

Returns:

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

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

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

public XReferenceType

Returns:

The XReferenceType of this crossreference stream entry.
getType()

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

Returns the XReferenceType of this crossreference stream entry.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

typeback to summary
private final XReferenceType type

Constructor Detail

AbstractXReferenceback to summary
protected AbstractXReference(XReferenceType type)

Creates a crossreference stream entry of the given XReferenceType.

Parameters
type:XReferenceType

The XReferenceType of the crossreference stream entry.

Method Detail

compareToback to summary
public int compareTo(XReferenceEntry xReferenceEntry)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Parameters
xReferenceEntry:XReferenceEntry

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
getFirstColumnValueback to summary
public long getFirstColumnValue()

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

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

Returns:long

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

Annotations
@Override
getTypeback to summary
public XReferenceType getType()

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

Returns the XReferenceType of this crossreference stream entry.

Returns:XReferenceType

The XReferenceType of this crossreference stream entry.

Annotations
@Override