de.intarsys.pdf.st
Class STXRefEntry

java.lang.Object
  de.intarsys.pdf.st.STXRefEntry

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

STXRefEntryCompressed, STXRefEntryFree, STXRefEntryOccupied

public abstract class STXRefEntry
extends Object
implements Comparable

Abstract superclass for a XRef entry.

The XRef entry describes an object slot in a XRef. The entry consists of an offset in the file, a generation number and a token indicating if this entry is free.

Method Summary

abstract void	accept(de.intarsys.pdf.st.IXRefEntryVisitor visitor)
int	compareTo(Object obj)
abstract STXRefEntry	copy()
abstract STXRefEntryOccupied	fill(int pos)
abstract long	getColumn1()
abstract int	getColumn2()
int	getGenerationNumber()
COSObjectKey	getKey()
int	getObjectNumber()
abstract boolean	isFree()
abstract COSObject	load(STDocument doc, ISystemSecurityHandler securityHandler)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

isFree

public abstract boolean isFree()

getGenerationNumber

public int getGenerationNumber()

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

fill

public abstract STXRefEntryOccupied fill(int pos)

getObjectNumber

public int getObjectNumber()

toString

public String toString()

Overrides:

toString in class Object

load

public abstract COSObject load(STDocument doc,
                               ISystemSecurityHandler securityHandler)
                        throws IOException,
                               COSLoadException

Throws:

IOException

COSLoadException

getColumn1

public abstract long getColumn1()

getColumn2

public abstract int getColumn2()

getKey

public COSObjectKey getKey()

accept

public abstract void accept(de.intarsys.pdf.st.IXRefEntryVisitor visitor)
                     throws XRefEntryVisitorException

Throws:

XRefEntryVisitorException

copy

public abstract STXRefEntry copy()