Top Description Constructors Methods
org.apache.pdfbox.pdmodel.common

public Class PDObjectStream

extends PDStream
Class Inheritance
Imports
org.apache.pdfbox.cos.COSName, .COSStream, org.apache.pdfbox.pdmodel.PDDocument
A PDStream represents a stream in a PDF document. Streams are tied to a single PDF document.
Author
Ben Litchfield

Constructor Summary

AccessConstructor and Description
public
PDObjectStream(COSStream
The stream parameter.
str)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public static PDObjectStream

Returns:

A new stream object.
createStream(PDDocument
The document that the stream will be part of.
document)

This will create a new PDObjectStream object.

public PDObjectStream

Returns:

The object that this stream is an extension.
getExtends()

A reference to an object stream, of which the current object stream is considered an extension.

public int

Returns:

The byte offset to the first object.
getFirstByteOffset()

The byte offset (in the decoded stream) of the first compressed object.

public int

Returns:

The number of compressed objects.
getNumberOfObjects()

Get the number of compressed object.

public String

Returns:

The type of this object.
getType()

Get the type of this object, should always return "ObjStm".

public void
setExtends(PDObjectStream
The object stream extension.
stream)

A reference to an object stream, of which the current object stream is considered an extension.

public void
setFirstByteOffset(int
The byte offset to the first object.
n)

The byte offset (in the decoded stream) of the first compressed object.

public void
setNumberOfObjects(int
The new number of objects.
n)

Set the number of objects.

Inherited from org.apache.pdfbox.pdmodel.common.PDStream:
createInputStreamcreateInputStreamcreateInputStreamcreateOutputStreamcreateOutputStreamgetCOSObjectgetDecodedStreamLengthgetDecodeParmsgetFilegetFileDecodeParamsgetFileFiltersgetFiltersgetLengthgetMetadatasetDecodedStreamLengthsetDecodeParmssetFilesetFileDecodeParamssetFileFilterssetFilterssetMetadatatoByteArray

Constructor Detail

PDObjectStreamback to summary
public PDObjectStream(COSStream str)

Constructor.

Parameters
str:COSStream

The stream parameter.

Method Detail

createStreamback to summary
public static PDObjectStream createStream(PDDocument document)

This will create a new PDObjectStream object.

Parameters
document:PDDocument

The document that the stream will be part of.

Returns:PDObjectStream

A new stream object.

getExtendsback to summary
public PDObjectStream getExtends()

A reference to an object stream, of which the current object stream is considered an extension.

Returns:PDObjectStream

The object that this stream is an extension.

getFirstByteOffsetback to summary
public int getFirstByteOffset()

The byte offset (in the decoded stream) of the first compressed object.

Returns:int

The byte offset to the first object.

getNumberOfObjectsback to summary
public int getNumberOfObjects()

Get the number of compressed object.

Returns:int

The number of compressed objects.

getTypeback to summary
public String getType()

Get the type of this object, should always return "ObjStm".

Returns:String

The type of this object.

setExtendsback to summary
public void setExtends(PDObjectStream stream)

A reference to an object stream, of which the current object stream is considered an extension.

Parameters
stream:PDObjectStream

The object stream extension.

setFirstByteOffsetback to summary
public void setFirstByteOffset(int n)

The byte offset (in the decoded stream) of the first compressed object.

Parameters
n:int

The byte offset to the first object.

setNumberOfObjectsback to summary
public void setNumberOfObjects(int n)

Set the number of objects.

Parameters
n:int

The new number of objects.