org.apache.pdfbox.pdmodel.common

Class COSStreamArray

java.lang.Object

org.apache.pdfbox.cos.COSBase

org.apache.pdfbox.cos.COSDictionary

org.apache.pdfbox.cos.COSStream

org.apache.pdfbox.pdmodel.common.COSStreamArray

All Implemented Interfaces:

Closeable, AutoCloseable, COSUpdateInfo, COSObjectable

public class COSStreamArray
extends COSStream

This will take an array of streams and sequence them together.

Author:

Ben Litchfield

Field Summary

Fields inherited from class org.apache.pdfbox.cos.COSDictionary

items

Constructor Summary

Constructors

Constructor and Description
COSStreamArray(COSArray array) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	accept(ICOSVisitor visitor) visitor pattern double dispatch method.
void	appendStream(COSStream streamToAppend) Appends a new stream to the array that represents this object's stream.
OutputStream	createFilteredStream() This will create a new stream for which filtered byte should be written to.
OutputStream	createFilteredStream(COSBase expectedLength) This will create a new stream for which filtered byte should be written to.
OutputStream	createUnfilteredStream() This will create an output stream that can be written to.
boolean	equals(Object o)
COSBase	get(int index) This will get a stream (or the reference to a stream) from the array.
COSDictionary	getDictionary() This will get the dictionary that is associated with this stream.
COSBase	getDictionaryObject(COSName key) This will get an object from this dictionary.
RandomAccessRead	getFilteredRandomAccess() This will get the data with all of the filters applied.
InputStream	getFilteredStream() This will get the stream with all of the filters applied.
COSBase	getFilters() This will return the filters to apply to the byte stream.
COSBase	getItem(COSName key) This will do a lookup into the dictionary.
int	getStreamCount() This will get the number of streams in the array.
RandomAccessRead	getUnfilteredRandomAccess() This will get the logical content with none of the filters.
InputStream	getUnfilteredStream() This will get the logical content stream with none of the filters.
void	insertCOSStream(PDStream streamToBeInserted) Insert the given stream at the beginning of the existing stream array.
void	setFilters(COSBase filters) set the filters to be applied to the stream.
String	toString()

Methods inherited from class org.apache.pdfbox.cos.COSStream

close, getDecodeResult, getFilteredLength, getOriginLength, getString, isEndstreamKeywordEOLCompliant, isStreamKeywordCRLFCompliant, setEndstreamKeywordEOLCompliant, setOriginLength, setStreamKeywordCRLFCompliant

Methods inherited from class org.apache.pdfbox.cos.COSDictionary

addAll, asUnmodifiableDictionary, clear, containsKey, containsKey, containsValue, entrySet, getBoolean, getBoolean, getBoolean, getCOSName, getCOSName, getDate, getDate, getDate, getDate, getDictionaryObject, getDictionaryObject, getDictionaryObject, getEmbeddedDate, getEmbeddedDate, getEmbeddedDate, getEmbeddedDate, getEmbeddedInt, getEmbeddedInt, getEmbeddedInt, getEmbeddedInt, getEmbeddedString, getEmbeddedString, getEmbeddedString, getEmbeddedString, getFlag, getFloat, getFloat, getFloat, getFloat, getInt, getInt, getInt, getInt, getInt, getInt, getInt, getItem, getKeyForValue, getLong, getLong, getLong, getLong, getLong, getNameAsString, getNameAsString, getNameAsString, getNameAsString, getObjectFromPath, getString, getString, getString, getString, getValues, isNeedToBeUpdated, keySet, mergeInto, removeItem, setBoolean, setBoolean, setDate, setDate, setEmbeddedDate, setEmbeddedDate, setEmbeddedInt, setEmbeddedInt, setEmbeddedString, setEmbeddedString, setFlag, setFloat, setFloat, setInt, setInt, setItem, setItem, setItem, setItem, setLong, setLong, setName, setName, setNeedToBeUpdated, setString, setString, size

Methods inherited from class org.apache.pdfbox.cos.COSBase

getCOSObject, getKey, isDirect, setDirect, setKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

COSStreamArray

public COSStreamArray(COSArray array)

Constructor.

Parameters:

array - The array of COSStreams to concatenate together.

Method Detail

get

public COSBase get(int index)

This will get a stream (or the reference to a stream) from the array.

Parameters:

index - The index of the requested stream

Returns:

The stream object or a reference to a stream

getStreamCount

public int getStreamCount()

This will get the number of streams in the array.

Returns:

the number of streams

getItem

public COSBase getItem(COSName key)

This will do a lookup into the dictionary.

Overrides:

getItem in class COSDictionary

Parameters:

key - The key to the object.

Returns:

The item that matches the key.

getDictionaryObject

public COSBase getDictionaryObject(COSName key)

This will get an object from this dictionary. If the object is a reference then it will dereference it and get it from the document. If the object is COSNull then null will be returned.

Overrides:

getDictionaryObject in class COSDictionary

Parameters:

key - The key to the object that we are getting.

Returns:

The object that matches the key.

toString

public String toString()

Overrides:

toString in class COSDictionary

getDictionary

public COSDictionary getDictionary()

This will get the dictionary that is associated with this stream.

Returns:

the object that is associated with this stream.

getFilteredStream

public InputStream getFilteredStream()
                              throws IOException

This will get the stream with all of the filters applied.

Overrides:

getFilteredStream in class COSStream

Returns:

the bytes of the physical (encoded) stream

Throws:

IOException - when encoding causes an exception

getFilteredRandomAccess

public RandomAccessRead getFilteredRandomAccess()
                                         throws IOException

This will get the data with all of the filters applied.

Overrides:

getFilteredRandomAccess in class COSStream

Returns:

the data of the physical (encoded) stream

Throws:

IOException - when encoding causes an exception

getUnfilteredStream

public InputStream getUnfilteredStream()
                                throws IOException

This will get the logical content stream with none of the filters.

Overrides:

getUnfilteredStream in class COSStream

Returns:

the bytes of the logical (decoded) stream

Throws:

IOException - when decoding causes an exception

getUnfilteredRandomAccess

public RandomAccessRead getUnfilteredRandomAccess()
                                           throws IOException

This will get the logical content with none of the filters.

Overrides:

getUnfilteredRandomAccess in class COSStream

Returns:

the bytes of the logical (decoded) stream

Throws:

IOException - when decoding causes an exception

accept

public Object accept(ICOSVisitor visitor)
              throws IOException

visitor pattern double dispatch method.

Overrides:

accept in class COSStream

Parameters:

visitor - The object to notify when visiting this object.

Returns:

The object that the visitor returns.

Throws:

IOException - If there is an error visiting this object.

getFilters

public COSBase getFilters()

This will return the filters to apply to the byte stream. The method will return - null if no filters are to be applied - a COSName if one filter is to be applied - a COSArray containing COSNames if multiple filters are to be applied

Overrides:

getFilters in class COSStream

Returns:

the COSBase object representing the filters

createFilteredStream

public OutputStream createFilteredStream()
                                  throws IOException

This will create a new stream for which filtered byte should be written to. You probably don't want this but want to use the createUnfilteredStream, which is used to write raw bytes to.

Overrides:

createFilteredStream in class COSStream

Returns:

A stream that can be written to.

Throws:

IOException - If there is an error creating the stream.

createFilteredStream

public OutputStream createFilteredStream(COSBase expectedLength)
                                  throws IOException

This will create a new stream for which filtered byte should be written to. You probably don't want this but want to use the createUnfilteredStream, which is used to write raw bytes to.

Overrides:

createFilteredStream in class COSStream

Parameters:

expectedLength - An entry where a length is expected.

Returns:

A stream that can be written to.

Throws:

IOException - If there is an error creating the stream.

setFilters

public void setFilters(COSBase filters)
                throws IOException

set the filters to be applied to the stream.

Overrides:

setFilters in class COSStream

Parameters:

filters - The filters to set on this stream.

Throws:

IOException - If there is an error clearing the old filters.

createUnfilteredStream

public OutputStream createUnfilteredStream()
                                    throws IOException

This will create an output stream that can be written to.

Overrides:

createUnfilteredStream in class COSStream

Returns:

An output stream which raw data bytes should be written to.

Throws:

IOException - If there is an error creating the stream.

appendStream

public void appendStream(COSStream streamToAppend)

Appends a new stream to the array that represents this object's stream.

Parameters:

streamToAppend - The stream to append.

insertCOSStream

public void insertCOSStream(PDStream streamToBeInserted)

Insert the given stream at the beginning of the existing stream array.

Parameters:

streamToBeInserted -

equals

public boolean equals(Object o)

Overrides:

equals in class COSStream