org.pdfbox.pdmodel.common

Class PDObjectStream

Implemented Interfaces:
COSObjectable

public class PDObjectStream
extends PDStream

A PDStream represents a stream in a PDF document. Streams are tied to a single PDF document.
Version:
$Revision: 1.3 $
Author:
Ben Litchfield

Constructor Summary

PDObjectStream(COSStream str)
Constructor.

Method Summary

static PDObjectStream
createStream(PDDocument document)
This will create a new PDStream object.
PDObjectStream
getExtends()
A reference to an object stream, of which the current object stream is considered an extension.
int
getFirstByteOffset()
The byte offset (in the decoded stream) of the first compressed object.
int
getNumberOfObjects()
Get the number of compressed object.
String
getType()
Get the type of this object, should always return "ObjStm".
void
setExtends(PDObjectStream stream)
A reference to an object stream, of which the current object stream is considered an extension.
void
setFirstByteOffset(int n)
The byte offset (in the decoded stream) of the first compressed object.
void
setNumberOfObjects(int n)
Set the number of objects.

Methods inherited from class org.pdfbox.pdmodel.common.PDStream

addCompression, createFromCOS, createInputStream, createOutputStream, getByteArray, getCOSObject, getDecodeParams, getFile, getFileDecodeParams, getFileFilters, getFilters, getInputStreamAsString, getLength, getMetadata, getPartiallyFilteredStream, getStream, setDecodeParams, setFile, setFileDecodeParams, setFileFilters, setFilters, setMetadata

Constructor Details

PDObjectStream

public PDObjectStream(COSStream str)
Constructor.
Parameters:
str - The stream parameter.

Method Details

createStream

public static PDObjectStream createStream(PDDocument document)
This will create a new PDStream object.
Parameters:
document - The document that the stream will be part of.
Returns:
A new stream object.

getExtends

public PDObjectStream getExtends()
A reference to an object stream, of which the current object stream is considered an extension.
Returns:
The object that this stream is an extension.

getFirstByteOffset

public int getFirstByteOffset()
The byte offset (in the decoded stream) of the first compressed object.
Returns:
The byte offset to the first object.

getNumberOfObjects

public int getNumberOfObjects()
Get the number of compressed object.
Returns:
The number of compressed objects.

getType

public String getType()
Get the type of this object, should always return "ObjStm".
Returns:
The type of this object.

setExtends

public void setExtends(PDObjectStream stream)
A reference to an object stream, of which the current object stream is considered an extension.
Parameters:
stream - The object stream extension.

setFirstByteOffset

public void setFirstByteOffset(int n)
The byte offset (in the decoded stream) of the first compressed object.
Parameters:
n - The byte offset to the first object.

setNumberOfObjects

public void setNumberOfObjects(int n)
Set the number of objects.
Parameters:
n - The new number of objects.