org.pdfbox.pdfwriter

Class COSWriterXRefEntry

Implemented Interfaces:
Comparable

public class COSWriterXRefEntry
extends java.lang.Object
implements Comparable

this is en entry in the xref section of the physical pdf document generated by the COSWriter.
Version:
$Revision: 1.7 $
Author:
Michael Traut

Constructor Summary

COSWriterXRefEntry(long start, COSBase obj, COSObjectKey keyValue)
COSWriterXRefEntry constructor comment.

Method Summary

int
compareTo(Object obj)
COSObjectKey
getKey()
This will get the Object key.
COSBase
getObject()
This will get the object.
long
getOffset()
This will get the offset into the document.
boolean
isFree()
Gets the xref 'free' attribute.
void
setFree(boolean newFree)
This will set the free attribute.
void
setOffset(long newOffset)
The offset attribute.

Constructor Details

COSWriterXRefEntry

public COSWriterXRefEntry(long start,
                          COSBase obj,
                          COSObjectKey keyValue)
COSWriterXRefEntry constructor comment.
Parameters:
start - The start attribute.
obj - The COS object that this entry represents.
keyValue - The key to the COS object.

Method Details

compareTo

public int compareTo(Object obj)

getKey

public COSObjectKey getKey()
This will get the Object key.
Returns:
The object key.

getObject

public COSBase getObject()
This will get the object.
Returns:
The object.

getOffset

public long getOffset()
This will get the offset into the document.
Returns:
The offset into the document.

isFree

public boolean isFree()
Gets the xref 'free' attribute.
Returns:
The free attribute.

setFree

public void setFree(boolean newFree)
This will set the free attribute.
Parameters:
newFree - The newly freed attribute.

setOffset

public void setOffset(long newOffset)
The offset attribute.
Parameters:
newOffset - The new value for the offset.