Class PDFXRefStream

java.lang.Object
org.apache.pdfbox.pdfparser.PDFXRefStream
All Implemented Interfaces:
PDFXRef

public class PDFXRefStream extends Object implements PDFXRef
Version:
$Revision: $
Author:
Alexander Funk
  • Constructor Details

    • PDFXRefStream

      public PDFXRefStream()
      Create a fresh XRef stream like for a fresh file or an incremental update.
  • 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
    • setSize

      public void setSize(long streamSize)
      Set the size of the XRef stream.
      Parameters:
      streamSize - size to bet set as stream size
    • 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