Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.common.PDStream

Modifier and Type	Field and Description
private static final Log	LOG
private final COSStream	stream

Access	Constructor and Description
public	PDStream(PDDocument The document that the stream will be part of. document) Creates a new empty PDStream object.
public	PDStream(COSDocument The document that the stream will be part of. document) Creates a new empty PDStream object.
public	PDStream(COSStream The stream parameter. str) Creates a PDStream which wraps the given COSStream.
public	PDStream(PDDocument The document that will hold the stream. doc, InputStream The stream parameter. input) Constructor.
public	PDStream(PDDocument The document that will hold the stream. doc, InputStream The stream parameter. input, COSName Filter to apply to the stream. filter) Constructor.
public	PDStream(PDDocument The document that will hold the stream. doc, InputStream The stream parameter. input, COSArray Filters to apply to the stream. filters) Constructor.
private	PDStream(PDDocument doc, InputStream input, COSBase filters) Constructor.

Method Summary

Modifier and Type	Method and Description
public COSInputStream	Returns: An input stream that can be read from. createInputStream() This will get a stream that can be read from.
public COSInputStream	createInputStream(DecodeOptions options)
public InputStream	Returns: A stream with decoded data. createInputStream(List<String> A list of filters to stop decoding at. stopFilters) This will get a stream with some filters applied but not others.
public OutputStream	Returns: An output stream to write data to. createOutputStream() This will get a stream that can be written to.
public OutputStream	Returns: An output stream to write data to. createOutputStream(COSName the filter to be used. filter) This will get a stream that can be written to, with the given filter.
public COSStream	Returns: The cos object that matches this Java object. getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Get the cos stream associated with this object.
public int	Returns: the decoded stream length getDecodedStreamLength() Get the decoded stream length.
public List<Object>	Returns: The list of decode parameters. getDecodeParms() Get the list of decode parameters.
public PDFileSpecification	Returns: The file specification. getFile() This will get the file specification for this stream.
public List<Object>	Returns: The list of decode parameters. getFileDecodeParams() Get the list of decode parameters.
public List<String>	Returns: A list of all encoding filters to apply to this stream. getFileFilters() This will get the list of filters that are associated with this stream.
public List<COSName>	Returns: A (possibly empty) list of all encoding filters to apply to this stream, never null. getFilters() This will get the list of filters that are associated with this stream.
public int	Returns: The length of the filtered stream. getLength() This will get the length of the filtered/compressed stream.
public PDMetadata	Returns: The metadata for this object. getMetadata() Get the metadata that is part of the document catalog.
private List<Object>	internalGetDecodeParams(COSName name1, COSName name2)
public void	setDecodedStreamLength(int the decoded stream length decodedStreamLength) Set the decoded stream length.
public void	setDecodeParms(List<?> The list of decode parameters. decodeParams) This will set the list of decode parameters.
public void	setFile(PDFileSpecification The file specification. f) Set the file specification.
public void	setFileDecodeParams(List<?> The list of decode params. decodeParams) This will set the list of decode params.
public void	setFileFilters(List<String> The filters that are part of this stream. filters) This will set the filters that are part of this stream.
public void	setFilters(List<COSName> The filters that are part of this stream. filters) This will set the filters that are part of this stream.
public void	setMetadata(PDMetadata The meta data for this object. meta) Set the metadata for this object.
public byte[]	Returns: The byte array of the filteredStream. toByteArray() This will copy the stream into a byte array.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

LOG	back to summary
private static final Log LOG

stream	back to summary
private final COSStream stream

Constructor Detail

PDStream	back to summary
public PDStream(PDDocument document) Creates a new empty PDStream object. Parameters document:PDDocument The document that the stream will be part of.

PDStream

back to summary

public PDStream(PDDocument document)

Creates a new empty PDStream object.

Parameters

document:PDDocument: The document that the stream will be part of.

PDStream	back to summary
public PDStream(COSDocument document) Creates a new empty PDStream object. Parameters document:COSDocument The document that the stream will be part of.

PDStream

back to summary

public PDStream(COSDocument document)

Creates a new empty PDStream object.

Parameters

document:COSDocument: The document that the stream will be part of.

PDStream	back to summary
public PDStream(COSStream str) Creates a PDStream which wraps the given COSStream. Parameters str:COSStream The stream parameter.

PDStream

back to summary

public PDStream(COSStream str)

Creates a PDStream which wraps the given COSStream.

Parameters

str:COSStream: The stream parameter.

PDStream	back to summary
public PDStream(PDDocument doc, InputStream input) throws IOException Constructor. Reads all data from the input stream and embeds it into the document. This method closes the InputStream. Parameters doc:PDDocument The document that will hold the stream. input:InputStream The stream parameter. Exceptions IOException: If there is an error creating the stream in the document.

PDStream

back to summary

public PDStream(PDDocument doc, InputStream input) throws IOException

Constructor. Reads all data from the input stream and embeds it into the document. This method closes the InputStream.

Parameters

doc:PDDocument: The document that will hold the stream.
input:InputStream: The stream parameter.

Exceptions

IOException:: If there is an error creating the stream in the document.

PDStream	back to summary
public PDStream(PDDocument doc, InputStream input, COSName filter) throws IOException Constructor. Reads all data from the input stream and embeds it into the document with the given filter applied. This method closes the InputStream. Parameters doc:PDDocument The document that will hold the stream. input:InputStream The stream parameter. filter:COSName Filter to apply to the stream. Exceptions IOException: If there is an error creating the stream in the document.

PDStream

back to summary

public PDStream(PDDocument doc, InputStream input, COSName filter) throws IOException

Constructor. Reads all data from the input stream and embeds it into the document with the given filter applied. This method closes the InputStream.

Parameters

doc:PDDocument: The document that will hold the stream.
input:InputStream: The stream parameter.
filter:COSName: Filter to apply to the stream.

Exceptions

IOException:: If there is an error creating the stream in the document.

PDStream	back to summary
public PDStream(PDDocument doc, InputStream input, COSArray filters) throws IOException Constructor. Reads all data from the input stream and embeds it into the document with the given filters applied. This method closes the InputStream. Parameters doc:PDDocument The document that will hold the stream. input:InputStream The stream parameter. filters:COSArray Filters to apply to the stream. Exceptions IOException: If there is an error creating the stream in the document.

PDStream

back to summary

public PDStream(PDDocument doc, InputStream input, COSArray filters) throws IOException

Constructor. Reads all data from the input stream and embeds it into the document with the given filters applied. This method closes the InputStream.

Parameters

doc:PDDocument: The document that will hold the stream.
input:InputStream: The stream parameter.
filters:COSArray: Filters to apply to the stream.

Exceptions

IOException:: If there is an error creating the stream in the document.

PDStream	back to summary
private PDStream(PDDocument doc, InputStream input, COSBase filters) throws IOException Constructor. Reads all data from the input stream and embeds it into the document with the given filters applied, if any. This method closes the InputStream.

Method Detail

createInputStream	back to summary
public COSInputStream createInputStream() throws IOException This will get a stream that can be read from. Returns:COSInputStream An input stream that can be read from. Exceptions IOException: If an IO error occurs during reading.

createInputStream

back to summary

public COSInputStream createInputStream() throws IOException

This will get a stream that can be read from.

Returns:COSInputStream

An input stream that can be read from.

Exceptions

IOException:: If an IO error occurs during reading.

createInputStream	back to summary
public COSInputStream createInputStream(DecodeOptions options) throws IOException

createInputStream	back to summary
public InputStream createInputStream(List<String> stopFilters) throws IOException This will get a stream with some filters applied but not others. This is useful when doing images, ie filters = [flate,dct], we want to remove flate but leave dct Parameters stopFilters:List<String> A list of filters to stop decoding at. Returns:InputStream A stream with decoded data. Exceptions IOException: If there is an error processing the stream.

createInputStream

back to summary

public InputStream createInputStream(List<String> stopFilters) throws IOException

This will get a stream with some filters applied but not others. This is useful when doing images, ie filters = [flate,dct], we want to remove flate but leave dct

Parameters

stopFilters:List<String>: A list of filters to stop decoding at.

Returns:InputStream

A stream with decoded data.

Exceptions

IOException:: If there is an error processing the stream.

createOutputStream	back to summary
public OutputStream createOutputStream() throws IOException This will get a stream that can be written to. Returns:OutputStream An output stream to write data to. Exceptions IOException: If an IO error occurs during writing.

createOutputStream

back to summary

public OutputStream createOutputStream() throws IOException

This will get a stream that can be written to.

Returns:OutputStream

An output stream to write data to.

Exceptions

IOException:: If an IO error occurs during writing.

createOutputStream	back to summary
public OutputStream createOutputStream(COSName filter) throws IOException This will get a stream that can be written to, with the given filter. Parameters filter:COSName the filter to be used. Returns:OutputStream An output stream to write data to. Exceptions IOException: If an IO error occurs during writing.

createOutputStream

back to summary

public OutputStream createOutputStream(COSName filter) throws IOException

This will get a stream that can be written to, with the given filter.

Parameters

filter:COSName: the filter to be used.

Returns:OutputStream

An output stream to write data to.

Exceptions

IOException:: If an IO error occurs during writing.

getCOSObject	back to summary
public COSStream getCOSObject() Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject. Get the cos stream associated with this object. Returns:COSStream The cos object that matches this Java object. Annotations @Override

getCOSObject

back to summary

public COSStream getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Get the cos stream associated with this object.

Returns:COSStream

The cos object that matches this Java object.

Annotations

@Override

getDecodedStreamLength	back to summary
public int getDecodedStreamLength() Get the decoded stream length. Returns:int the decoded stream length

getDecodedStreamLength

back to summary

public int getDecodedStreamLength()

Get the decoded stream length.

Returns:int: the decoded stream length

getDecodeParms	back to summary
public List<Object> getDecodeParms() throws IOException Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list. Returns:List<Object> The list of decode parameters. Exceptions IOException: if there is an error retrieving the parameters.

getDecodeParms

back to summary

public List<Object> getDecodeParms() throws IOException

Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list.

Returns:List<Object>

The list of decode parameters.

Exceptions

IOException:: if there is an error retrieving the parameters.

getFile	back to summary
public PDFileSpecification getFile() throws IOException This will get the file specification for this stream. This is only required for external files. Returns:PDFileSpecification The file specification. Exceptions IOException: If there is an error creating the file spec.

getFile

back to summary

public PDFileSpecification getFile() throws IOException

This will get the file specification for this stream. This is only required for external files.

Returns:PDFileSpecification

The file specification.

Exceptions

IOException:: If there is an error creating the file spec.

getFileDecodeParams	back to summary
public List<Object> getFileDecodeParams() throws IOException Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list. Returns:List<Object> The list of decode parameters. Exceptions IOException: if there is an error retrieving the parameters.

getFileDecodeParams

back to summary

public List<Object> getFileDecodeParams() throws IOException

Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list.

Returns:List<Object>

The list of decode parameters.

Exceptions

IOException:: if there is an error retrieving the parameters.

getFileFilters	back to summary
public List<String> getFileFilters() This will get the list of filters that are associated with this stream. The list is empty if there are none. Returns:List<String> A list of all encoding filters to apply to this stream.

getFileFilters

back to summary

public List<String> getFileFilters()

This will get the list of filters that are associated with this stream. The list is empty if there are none.

Returns:List<String>: A list of all encoding filters to apply to this stream.

getFilters	back to summary
public List<COSName> getFilters() This will get the list of filters that are associated with this stream. Returns:List<COSName> A (possibly empty) list of all encoding filters to apply to this stream, never null.

getFilters

back to summary

public List<COSName> getFilters()

This will get the list of filters that are associated with this stream.

Returns:List<COSName>: A (possibly empty) list of all encoding filters to apply to this stream, never null.

getLength	back to summary
public int getLength() This will get the length of the filtered/compressed stream. This is readonly in the PD Model and will be managed by this class. Returns:int The length of the filtered stream.

getLength

back to summary

public int getLength()

This will get the length of the filtered/compressed stream. This is readonly in the PD Model and will be managed by this class.

Returns:int: The length of the filtered stream.

getMetadata

back to summary

public PDMetadata getMetadata()

Get the metadata that is part of the document catalog. This will return null if there is no meta data for this object.

Returns:PDMetadata

The metadata for this object.

Exceptions

IllegalStateException:: if the value of the metadata entry is different from a stream or null

internalGetDecodeParams	back to summary
private List<Object> internalGetDecodeParams(COSName name1, COSName name2) throws IOException

setDecodedStreamLength	back to summary
public void setDecodedStreamLength(int decodedStreamLength) Set the decoded stream length. Parameters decodedStreamLength:int the decoded stream length

setDecodedStreamLength

back to summary

public void setDecodedStreamLength(int decodedStreamLength)

Set the decoded stream length.

Parameters

decodedStreamLength:int: the decoded stream length

setDecodeParms	back to summary
public void setDecodeParms(List<?> decodeParams) This will set the list of decode parameters. Parameters decodeParams:List<?> The list of decode parameters.

setDecodeParms

back to summary

public void setDecodeParms(List<?> decodeParams)

This will set the list of decode parameters.

Parameters

decodeParams:List<?>: The list of decode parameters.

setFile	back to summary
public void setFile(PDFileSpecification f) Set the file specification. Parameters f:PDFileSpecification The file specification.

setFile

back to summary

public void setFile(PDFileSpecification f)

Set the file specification.

Parameters

f:PDFileSpecification: The file specification.

setFileDecodeParams	back to summary
public void setFileDecodeParams(List<?> decodeParams) This will set the list of decode params. Parameters decodeParams:List<?> The list of decode params.

setFileDecodeParams

back to summary

public void setFileDecodeParams(List<?> decodeParams)

This will set the list of decode params.

Parameters

decodeParams:List<?>: The list of decode params.

setFileFilters	back to summary
public void setFileFilters(List<String> filters) This will set the filters that are part of this stream. Parameters filters:List<String> The filters that are part of this stream.

setFileFilters

back to summary

public void setFileFilters(List<String> filters)

This will set the filters that are part of this stream.

Parameters

filters:List<String>: The filters that are part of this stream.

setFilters	back to summary
public void setFilters(List<COSName> filters) This will set the filters that are part of this stream. Parameters filters:List<COSName> The filters that are part of this stream.

setFilters

back to summary

public void setFilters(List<COSName> filters)

This will set the filters that are part of this stream.

Parameters

filters:List<COSName>: The filters that are part of this stream.

setMetadata

back to summary

public void setMetadata(PDMetadata meta)

Set the metadata for this object. This can be null.

Parameters

meta:PDMetadata: The meta data for this object.

toByteArray	back to summary
public byte[] toByteArray() throws IOException This will copy the stream into a byte array. Returns:byte[] The byte array of the filteredStream. Exceptions IOException: if an I/O error occurs.

toByteArray

back to summary

public byte[] toByteArray() throws IOException

This will copy the stream into a byte array.

Returns:byte[]

The byte array of the filteredStream.

Exceptions

IOException:: if an I/O error occurs.

public Class PDStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail