Modifier and Type	Class and Description
private static class	Predictor.PredictorOutputStream Output stream that implements predictor decoding.

Access	Constructor and Description
private	Predictor()

Method Summary

Modifier and Type	Method and Description
pack-priv static int	calcSetBitSeq(int by, int startBit, int bitSize, int val)
pack-priv static int	calculateRowLength(int colors, int bitsPerComponent, int columns)
pack-priv static void	decodePredictorRow(int Predictor value for the current line predictor, int Number of color components, from decode parameters. colors, int Number of bits per components, from decode parameters. bitsPerComponent, int Number samples in a row, from decode parameters. columns, byte[] Current (active) line to decode. Data will be decoded in-place, i.e. - the contents of this buffer will be modified. actline, byte[] The previous decoded line. When decoding the first line, this parameter should be an empty byte array of the same length as `actline`. lastline) Decodes a single line of data in-place.
pack-priv static int	getBitSeq(int by, int startBit, int bitSize)
pack-priv static OutputStream	Returns: An `OutputStream` is returned, which will write decoded data into the given stream. If no predictor is specified, the original stream is returned. wrapPredictor(OutputStream The stream to which decoded data should be written out, COSDictionary Decode parameters for the stream decodeParams) Wraps and `OutputStream` in a predictor decoding stream as necessary.

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

Constructor Detail

Predictor	back to summary
private Predictor()

Method Detail

calcSetBitSeq	back to summary
pack-priv static int calcSetBitSeq(int by, int startBit, int bitSize, int val)

calculateRowLength	back to summary
pack-priv static int calculateRowLength(int colors, int bitsPerComponent, int columns)

decodePredictorRow back to summary

decodePredictorRow	back to summary
pack-priv static void decodePredictorRow(int predictor, int colors, int bitsPerComponent, int columns, byte[] actline, byte[] lastline) Decodes a single line of data in-place. Parameters predictor:int Predictor value for the current line colors:int Number of color components, from decode parameters. bitsPerComponent:int Number of bits per components, from decode parameters. columns:int Number samples in a row, from decode parameters. actline:byte[] Current (active) line to decode. Data will be decoded in-place, i.e. - the contents of this buffer will be modified. lastline:byte[] The previous decoded line. When decoding the first line, this parameter should be an empty byte array of the same length as `actline`.

pack-priv static void decodePredictorRow(int predictor, int colors, int bitsPerComponent, int columns, byte[] actline, byte[] lastline)

Decodes a single line of data in-place.

Parameters

predictor:int: Predictor value for the current line
colors:int: Number of color components, from decode parameters.
bitsPerComponent:int: Number of bits per components, from decode parameters.
columns:int: Number samples in a row, from decode parameters.
actline:byte[]: Current (active) line to decode. Data will be decoded in-place, i.e. - the contents of this buffer will be modified.
lastline:byte[]: The previous decoded line. When decoding the first line, this parameter should be an empty byte array of the same length as actline.

getBitSeq	back to summary
pack-priv static int getBitSeq(int by, int startBit, int bitSize)

wrapPredictor back to summary

wrapPredictor	back to summary
pack-priv static OutputStream wrapPredictor(OutputStream out, COSDictionary decodeParams) Wraps and `OutputStream` in a predictor decoding stream as necessary. If no predictor is specified by the parameters, the original stream is returned as is. Parameters out:OutputStream The stream to which decoded data should be written decodeParams:COSDictionary Decode parameters for the stream Returns:OutputStream An `OutputStream` is returned, which will write decoded data into the given stream. If no predictor is specified, the original stream is returned.

pack-priv static OutputStream wrapPredictor(OutputStream out, COSDictionary decodeParams)

Wraps and OutputStream in a predictor decoding stream as necessary. If no predictor is specified by the parameters, the original stream is returned as is.

Parameters

out:OutputStream: The stream to which decoded data should be written
decodeParams:COSDictionary: Decode parameters for the stream

Returns:OutputStream

An OutputStream is returned, which will write decoded data into the given stream. If no predictor is specified, the original stream is returned.

org.apache.pdfbox.filter back to summary

private final Class Predictor.PredictorOutputStream

Class Inheritance

extends FilterOutputStream

java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
org.apache.pdfbox.filter.Predictor.PredictorOutputStream

Output stream that implements predictor decoding. Data is buffered until a complete row is available, which is then decoded and written to the underlying stream. The previous row is retained for decoding the next row.

Field Summary

Modifier and Type	Field and Description
private final int	bitsPerComponent
private final int	colors
private final int	columns
private byte[]	currentRow
private int	currentRowData
private byte[]	lastRow
private int	predictor
private final boolean	predictorPerRow
private boolean	predictorRead
private final int	rowLength

Inherited from java.io.FilterOutputStream:: out

Constructor Summary

Access	Constructor and Description
pack-priv	PredictorOutputStream(OutputStream out, int predictor, int colors, int bitsPerComponent, int columns)

Method Summary

Modifier and Type	Method and Description
private void	decodeAndWriteRow()
private void	flipRows() Flips the row buffers (to avoid copying), and resets the current-row index and predictorRead flag
public void	flush() Overrides java.io.FilterOutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out to the stream.
public void	write(byte[] the data to be written. bytes) Overrides java.io.FilterOutputStream.write. Writes `b.length` bytes to this output stream.
public void	write(byte[] the data. bytes, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream.
public void	write(int the `byte`. i) Overrides java.io.FilterOutputStream.write. Writes the specified `byte` to this output stream.

Inherited from java.io.FilterOutputStream:: close

Field Detail

bitsPerComponent	back to summary
private final int bitsPerComponent

colors	back to summary
private final int colors

columns	back to summary
private final int columns

currentRow	back to summary
private byte[] currentRow

currentRowData	back to summary
private int currentRowData

lastRow	back to summary
private byte[] lastRow

predictor	back to summary
private int predictor

predictorPerRow	back to summary
private final boolean predictorPerRow

predictorRead	back to summary
private boolean predictorRead

rowLength	back to summary
private final int rowLength

Constructor Detail

PredictorOutputStream	back to summary
pack-priv PredictorOutputStream(OutputStream out, int predictor, int colors, int bitsPerComponent, int columns)

Method Detail

decodeAndWriteRow	back to summary
private void decodeAndWriteRow() throws IOException

flipRows	back to summary
private void flipRows() Flips the row buffers (to avoid copying), and resets the current-row index and predictorRead flag

flush	back to summary
public void flush() throws IOException Overrides java.io.FilterOutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.FilterOutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out to the stream. Annotations @Override Exceptions IOException: if an I/O error occurs.

flush

back to summary

public void flush() throws IOException

Overrides java.io.FilterOutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.FilterOutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out to the stream.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] bytes) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes `b.length` bytes to this output stream. Parameters bytes:byte[] the data to be written. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(byte[] bytes) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes b.length bytes to this output stream.

Parameters

bytes:byte[]: the data to be written.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] bytes, int off, int len) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream. Parameters bytes:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(byte[] bytes, int off, int len) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream.

Parameters

bytes:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(int i) throws IOException Overrides java.io.FilterOutputStream.write. Doc from java.io.FilterOutputStream.write. Writes the specified `byte` to this output stream. The `write` method of `FilterOutputStream` calls the `write` method of its underlying output stream, that is, it performs `out.write(b)`. Implements the abstract `write` method of `OutputStream`. Parameters i:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(int i) throws IOException

Overrides java.io.FilterOutputStream.write.

Doc from java.io.FilterOutputStream.write.

Writes the specified byte to this output stream.

The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b).

Implements the abstract write method of OutputStream.

Parameters

i:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

public final Class Predictor

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class Predictor.PredictorOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail