org.sejda.sambox.xref

Class CompressedXrefEntry

java.lang.Object

org.sejda.sambox.xref.XrefEntry

org.sejda.sambox.xref.CompressedXrefEntry

public final class CompressedXrefEntry
extends XrefEntry

An xref entry for a cross reference stream which represent a compressed objects (i.e. an object part of an object stream). See table 18 PDF32000:2008-1

Author:

Andrea Vacondio

Field Summary

Fields inherited from class org.sejda.sambox.xref.XrefEntry

DEFAULT_FREE_ENTRY, UNKNOWN_OFFSET

Method Summary

Modifier and Type	Method and Description
static CompressedXrefEntry	compressedEntry(long objectNumber, long objectStreamNumber, long index) Factory method for an entry in the xref stream representing a compressed object in an object stream
long	getObjectStreamNumber()
String	toString()
byte[]	toXrefStreamEntry(int secondFieldLength, int thirdFieldLength) Creates Cross-reference stream data for this entry as defined in Chap 7.5.8.3 of PDF32000-1:2008, table 18.

Methods inherited from class org.sejda.sambox.xref.XrefEntry

copyBytesTo, freeEntry, getByteOffset, getGenerationNumber, getObjectNumber, getType, inUseEntry, isUnknownOffset, key, owns, setByteOffset, toXrefTableEntry, unknownOffsetEntry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getObjectStreamNumber

public long getObjectStreamNumber()

Returns:

The object number of the object stream in which this object is stored.

toXrefStreamEntry

public byte[] toXrefStreamEntry(int secondFieldLength,
                                int thirdFieldLength)

Description copied from class: XrefEntry

Creates Cross-reference stream data for this entry as defined in Chap 7.5.8.3 of PDF32000-1:2008, table 18.

Overrides:

toXrefStreamEntry in class XrefEntry

Parameters:

secondFieldLength - length of the second field

thirdFieldLength - length of the second field

Returns:

an entry corresponding to this xref entry to be used in the xref stream.

toString

public String toString()

Overrides:

toString in class XrefEntry

compressedEntry

public static CompressedXrefEntry compressedEntry(long objectNumber,
                                                  long objectStreamNumber,
                                                  long index)

Factory method for an entry in the xref stream representing a compressed object in an object stream

Parameters:

objectNumber -

objectStreamNumber - The object number of the object stream in which this object is stored.

index - The index of this object within the object stream.

Returns:

the newly created instance