Package org.apache.pdfbox.pdfparser

Class PDFXRefStream

java.lang.Object

org.apache.pdfbox.pdfparser.PDFXRefStream

All Implemented Interfaces:

PDFXRef

public class PDFXRefStream
extends Object
implements PDFXRef

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	PDFXRefStream.FreeReference	A class representing a free reference.
(package private) static class	PDFXRefStream.NormalReference	A class representing a normal reference.
(package private) static class	PDFXRefStream.ObjectStreamReference	A class representing an object stream reference.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ENTRY_FREE
private static final int	ENTRY_NORMAL
private static final int	ENTRY_OBJSTREAM
private final Set<Long>	objectNumbers
private long	size
private final COSStream	stream
private final Map<Long,Object>	streamData

Constructor Summary

Constructors

Constructor	Description
PDFXRefStream()	Deprecated. use PDFXRefStream(org.apache.pdfbox.cos.COSDocument)
PDFXRefStream(COSDocument cosDocument)	Create a fresh XRef stream like for a fresh file or an incremental update.

Method Summary

Modifier and Type	Method	Description
void	addEntry(COSWriterXRefEntry entry)	Add an new entry to the XRef stream.
void	addTrailerInfo(COSDictionary trailerDict)	Copy all Trailer Information to this file.
private List<Long>	getIndexEntry()
COSObject	getObject(int objectNumber)	Returns the object referenced by the given object number.
COSStream	getStream()	Returns the stream of the XRef.
private int[]	getWEntry()	determines the minimal length required for all the lengths.
void	setSize(long streamSize)	Set the size of the XRef stream.
private void	writeNumber(OutputStream os, long number, int bytes)
private void	writeStreamData(OutputStream os, int[] w)

Methods inherited from class java.lang.Object

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

Field Details

ENTRY_OBJSTREAM

private static final int ENTRY_OBJSTREAM

See Also:

• Constant Field Values

ENTRY_NORMAL

private static final int ENTRY_NORMAL

See Also:

• Constant Field Values

ENTRY_FREE

private static final int ENTRY_FREE

See Also:

• Constant Field Values

streamData

private final Map<Long,Object> streamData

objectNumbers

private final Set<Long> objectNumbers

stream

private final COSStream stream

size

private long size

Constructor Details

PDFXRefStream

@Deprecated
public PDFXRefStream()

Deprecated.

use PDFXRefStream(org.apache.pdfbox.cos.COSDocument)

Create a fresh XRef stream like for a fresh file or an incremental update.

PDFXRefStream

public PDFXRefStream(COSDocument cosDocument)

Create a fresh XRef stream like for a fresh file or an incremental update.

Parameters:

cosDocument -

Method Details

getStream

public COSStream getStream()
                    throws IOException

Returns the stream of the XRef.

Returns:

the XRef stream

Throws:

IOException - if something went wrong

addTrailerInfo

public void addTrailerInfo(COSDictionary trailerDict)

Copy all Trailer Information to this file.

Parameters:

trailerDict - dictionary to be added as trailer info

addEntry

public void addEntry(COSWriterXRefEntry entry)

Add an new entry to the XRef stream.

Parameters:

entry - new entry to be added

getWEntry

private int[] getWEntry()

determines the minimal length required for all the lengths.

Returns:

the length information

setSize

public void setSize(long streamSize)

Set the size of the XRef stream.

Parameters:

streamSize - size to bet set as stream size

getIndexEntry

private List<Long> getIndexEntry()

writeNumber

private void writeNumber(OutputStream os,
 long number,
 int bytes)
                  throws IOException

Throws:

IOException

writeStreamData

private void writeStreamData(OutputStream os,
 int[] w)
                      throws IOException

Throws:

IOException

getObject

public COSObject getObject(int objectNumber)

Returns the object referenced by the given object number.

Specified by:

getObject in interface PDFXRef

Parameters:

objectNumber - the object to be returned

Returns:

the object corresponding to the given object number