org.apache.pdfbox.cos

Class COSStream

java.lang.Object

org.apache.pdfbox.cos.COSBase

org.apache.pdfbox.cos.COSDictionary

org.apache.pdfbox.cos.COSStream

All Implemented Interfaces:

Closeable, AutoCloseable, COSUpdateInfo, COSObjectable

Direct Known Subclasses:

COSStreamArray

public class COSStream
extends COSDictionary
implements Closeable

This class represents a stream object in a PDF document.

Author:

Ben Litchfield

Field Summary

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

items

Constructor Summary

Constructors

Constructor and Description
COSStream() Constructor.
COSStream(COSDictionary dictionary) Constructor.
COSStream(COSDictionary dictionary, ScratchFile scratchFile) Constructor.
COSStream(ScratchFile scratchFile) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	accept(ICOSVisitor visitor) visitor pattern double dispatch method.
void	close()
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 obj)
DecodeResult	getDecodeResult() Returns the repaired stream parameters dictionary.
long	getFilteredLength() This will get the length of the encoded stream.
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.
Long	getOriginLength()
String	getString() Returns the contents of the stream as a text string.
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.
Boolean	isEndstreamKeywordEOLCompliant()
boolean	isStreamKeywordCRLFCompliant()
void	setEndstreamKeywordEOLCompliant(Boolean endStreamSpacingsComplyPDFA)
void	setFilters(COSBase filters) set the filters to be applied to the stream.
void	setOriginLength(Long originLength)
void	setStreamKeywordCRLFCompliant(boolean streamSpacingsComplyPDFA)

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, 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, 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, toString

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

COSStream

public COSStream()

Constructor. Creates a new stream with an empty dictionary.

COSStream

public COSStream(COSDictionary dictionary)

Constructor.

Parameters:

dictionary - The dictionary that is associated with this stream.

COSStream

public COSStream(ScratchFile scratchFile)

Constructor. Creates a new stream with an empty dictionary.

Parameters:

scratchFile - scratch file to use.

COSStream

public COSStream(COSDictionary dictionary,
                 ScratchFile scratchFile)

Constructor.

Parameters:

dictionary - The dictionary that is associated with this stream.

scratchFile - The scratch file to use.

Method Detail

getFilteredStream

public InputStream getFilteredStream()
                              throws IOException

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

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.

Returns:

the data of the physical (encoded) stream

Throws:

IOException - when encoding causes an exception

getFilteredLength

public long getFilteredLength()
                       throws IOException

This will get the length of the encoded stream.

Returns:

the length of the encoded stream as long

Throws:

IOException - if something went wrong

getUnfilteredStream

public InputStream getUnfilteredStream()
                                throws IOException

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

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.

Returns:

the bytes of the logical (decoded) stream

Throws:

IOException - when decoding causes an exception

getDecodeResult

public DecodeResult getDecodeResult()
                             throws IOException

Returns the repaired stream parameters dictionary.

Returns:

the repaired stream parameters dictionary

Throws:

IOException - when encoding/decoding causes an exception

accept

public Object accept(ICOSVisitor visitor)
              throws IOException

Description copied from class: COSDictionary

visitor pattern double dispatch method.

Overrides:

accept in class COSDictionary

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

Returns:

the COSBase object representing the filters

getString

public String getString()

Returns the contents of the stream as a text string.

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.

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.

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.

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.

Returns:

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

Throws:

IOException - If there is an error creating the stream.

getOriginLength

public Long getOriginLength()

setOriginLength

public void setOriginLength(Long originLength)

isStreamKeywordCRLFCompliant

public boolean isStreamKeywordCRLFCompliant()

setStreamKeywordCRLFCompliant

public void setStreamKeywordCRLFCompliant(boolean streamSpacingsComplyPDFA)

isEndstreamKeywordEOLCompliant

public Boolean isEndstreamKeywordEOLCompliant()

setEndstreamKeywordEOLCompliant

public void setEndstreamKeywordEOLCompliant(Boolean endStreamSpacingsComplyPDFA)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class COSDictionary