Package 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
,COSObjectable
This will take an array of streams and sequence them together.
- Version:
- $Revision: 1.10 $
- Author:
- Ben Litchfield
-
Field Summary
Fields inherited from class org.apache.pdfbox.cos.COSDictionary
items
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccept
(ICOSVisitor visitor) visitor pattern double dispatch method.void
appendStream
(COSStream streamToAppend) Appends a new stream to the array that represents this object's stream.This will create a new stream for which filtered byte should be written to.createFilteredStream
(COSBase expectedLength) This will create a new stream for which filtered byte should be written to.This will create an output stream that can be written to.get
(int index) This will get a stream (or the reference to a stream) from the array.This will get the dictionary that is associated with this stream.This will get an object from this streams dictionary and dereference it if necessary.This will get the stream with all of the filters applied.This will return the filters to apply to the byte stream the method will return.This will get an object from this streams dictionary.This will get the scratch file associated with this stream.int
This will get the number of streams in the array.This will get all the tokens in the stream.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.toString()
Methods inherited from class org.apache.pdfbox.cos.COSStream
close, getFilteredLength, getFilteredLengthWritten, replaceWithStream, setFilteredLength
Methods inherited from class org.apache.pdfbox.cos.COSDictionary
addAll, clear, containsKey, containsKey, containsValue, entrySet, getBoolean, getBoolean, getBoolean, getDate, getDate, getDate, getDate, getDictionaryObject, getDictionaryObject, getDictionaryObject, getDictionaryObject, getEmbeddedDate, getEmbeddedDate, getEmbeddedDate, getEmbeddedDate, getEmbeddedInt, getEmbeddedInt, getEmbeddedInt, getEmbeddedInt, getEmbeddedString, getEmbeddedString, getEmbeddedString, getEmbeddedString, 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, keyList, keySet, mergeInto, removeItem, setBoolean, setBoolean, setDate, setDate, setEmbeddedDate, setEmbeddedDate, setEmbeddedInt, setEmbeddedInt, setEmbeddedString, setEmbeddedString, setFloat, setFloat, setInt, setInt, setItem, setItem, setItem, setItem, setLong, setLong, setName, setName, setString, setString, size
Methods inherited from class org.apache.pdfbox.cos.COSBase
getCOSObject, getFilterManager, isDirect, isNeedToBeUpdate, setDirect, setNeedToBeUpdate
-
Constructor Details
-
COSStreamArray
Constructor.- Parameters:
array
- The array of COSStreams to concatenate together.
-
-
Method Details
-
get
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
-
getScratchFile
This will get the scratch file associated with this stream.- Overrides:
getScratchFile
in classCOSStream
- Returns:
- The scratch file where this stream is being stored.
-
getItem
This will get an object from this streams dictionary.- Overrides:
getItem
in classCOSDictionary
- Parameters:
key
- The key to the object.- Returns:
- The dictionary object with the key or null if one does not exist.
-
getDictionaryObject
This will get an object from this streams dictionary and dereference it if necessary.- Overrides:
getDictionaryObject
in classCOSDictionary
- Parameters:
key
- The key to the object.- Returns:
- The dictionary object with the key or null if one does not exist.
-
toString
- Overrides:
toString
in classCOSDictionary
-
getStreamTokens
This will get all the tokens in the stream.- Overrides:
getStreamTokens
in classCOSStream
- Returns:
- All of the tokens in the stream.
- Throws:
IOException
- If there is an error parsing the stream.
-
getDictionary
This will get the dictionary that is associated with this stream.- Returns:
- the object that is associated with this stream.
-
getFilteredStream
This will get the stream with all of the filters applied.- Overrides:
getFilteredStream
in classCOSStream
- Returns:
- the bytes of the physical (endoced) stream
- Throws:
IOException
- when encoding/decoding causes an exception
-
getUnfilteredStream
This will get the logical content stream with none of the filters.- Overrides:
getUnfilteredStream
in classCOSStream
- Returns:
- the bytes of the logical (decoded) stream
- Throws:
IOException
- when encoding/decoding causes an exception
-
accept
visitor pattern double dispatch method.- Overrides:
accept
in classCOSStream
- Parameters:
visitor
- The object to notify when visiting this object.- Returns:
- any object, depending on the visitor implementation, or null
- Throws:
COSVisitorException
- If an error occurs while visiting this object.
-
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 classCOSStream
- Returns:
- the COSBase object representing the filters
-
createFilteredStream
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 classCOSStream
- Returns:
- A stream that can be written to.
- Throws:
IOException
- If there is an error creating the stream.
-
createFilteredStream
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 classCOSStream
- 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
set the filters to be applied to the stream.- Overrides:
setFilters
in classCOSStream
- Parameters:
filters
- The filters to set on this stream.- Throws:
IOException
- If there is an error clearing the old filters.
-
createUnfilteredStream
This will create an output stream that can be written to.- Overrides:
createUnfilteredStream
in classCOSStream
- Returns:
- An output stream which raw data bytes should be written to.
- Throws:
IOException
- If there is an error creating the stream.
-
appendStream
Appends a new stream to the array that represents this object's stream.- Parameters:
streamToAppend
- The stream to append.
-
insertCOSStream
Insert the given stream at the beginning of the existing stream array.- Parameters:
streamToBeInserted
-
-