Class COSWriterXRefEntry

java.lang.Object
org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
All Implemented Interfaces:
Comparable<COSWriterXRefEntry>

public class COSWriterXRefEntry extends Object implements Comparable<COSWriterXRefEntry>
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 Details

    • COSWriterXRefEntry

      public COSWriterXRefEntry(long start, COSBase obj, COSObjectKey keyValue)
      Constructor.
      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(COSWriterXRefEntry obj)
      Specified by:
      compareTo in interface Comparable<COSWriterXRefEntry>
    • getNullEntry

      public static COSWriterXRefEntry getNullEntry()
      This will return a null entry: 0000000000 65535 f
      Returns:
      null COSWriterXRefEntry
    • getKey

      public COSObjectKey getKey()
      This will get the Object key.
      Returns:
      The object key.
    • 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.
    • getObject

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