org.pdfbox.pdmodel.common
Class PDObjectStream
- COSObjectable
public class PDObjectStream
A PDStream represents a stream in a PDF document. Streams are tied to a single
PDF document.
addCompression , createFromCOS , createInputStream , createOutputStream , getByteArray , getCOSObject , getDecodeParams , getFile , getFileDecodeParams , getFileFilters , getFilters , getInputStreamAsString , getLength , getMetadata , getPartiallyFilteredStream , getStream , setDecodeParams , setFile , setFileDecodeParams , setFileFilters , setFilters , setMetadata |
PDObjectStream
public PDObjectStream(COSStream str)
Constructor.
str
- The stream parameter.
createStream
public static PDObjectStream createStream(PDDocument document)
This will create a new PDStream object.
document
- The document that the stream will be part of.
getExtends
public PDObjectStream getExtends()
A reference to an object stream, of which the current object stream is
considered an extension.
- The object that this stream is an extension.
getFirstByteOffset
public int getFirstByteOffset()
The byte offset (in the decoded stream) of the first compressed object.
- The byte offset to the first object.
getNumberOfObjects
public int getNumberOfObjects()
Get the number of compressed object.
- The number of compressed objects.
getType
public String getType()
Get the type of this object, should always return "ObjStm".
setExtends
public void setExtends(PDObjectStream stream)
A reference to an object stream, of which the current object stream is
considered an extension.
stream
- The object stream extension.
setFirstByteOffset
public void setFirstByteOffset(int n)
The byte offset (in the decoded stream) of the first compressed object.
n
- The byte offset to the first object.
setNumberOfObjects
public void setNumberOfObjects(int n)
Set the number of objects.
n
- The new number of objects.