Package org.apache.pdfbox.cos

Class COSInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.pdfbox.cos.COSInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public final class COSInputStream
extends FilterInputStream

An InputStream which reads from an encoded COS stream.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<DecodeResult>	decodeResults

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Modifier	Constructor	Description
private	COSInputStream(InputStream input, List<DecodeResult> decodeResults)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) static COSInputStream	create(List<Filter> filters, COSDictionary parameters, InputStream in)	Creates a new COSInputStream from an encoded input stream.
(package private) static COSInputStream	create(List<Filter> filters, COSDictionary parameters, InputStream in, DecodeOptions options)	Creates a new COSInputStream from an encoded input stream.
DecodeResult	getDecodeResult()	Returns the result of the last filter, for use by repair mechanisms.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

decodeResults

private final List<DecodeResult> decodeResults

Constructor Details

COSInputStream

private COSInputStream(InputStream input,
 List<DecodeResult> decodeResults)

Constructor.

Parameters:

input - decoded stream

decodeResults - results of decoding

Method Details

create

static COSInputStream create(List<Filter> filters,
 COSDictionary parameters,
 InputStream in)
                      throws IOException

Creates a new COSInputStream from an encoded input stream.

Parameters:

filters - Filters to be applied.

parameters - Filter parameters.

in - Encoded input stream.

Returns:

Decoded stream.

Throws:

IOException - If the stream could not be read.

create

static COSInputStream create(List<Filter> filters,
 COSDictionary parameters,
 InputStream in,
 DecodeOptions options)
                      throws IOException

Creates a new COSInputStream from an encoded input stream.

Parameters:

filters - Filters to be applied.

parameters - Filter parameters.

in - Encoded input stream.

options - decode options for the encoded stream

Returns:

Decoded stream.

Throws:

IOException - If the stream could not be read.

getDecodeResult

public DecodeResult getDecodeResult()

Returns the result of the last filter, for use by repair mechanisms.

Returns:

the result of the last filter