org.verapdf.as.filters.io

Class ASBufferingInFilter

java.lang.Object

java.io.InputStream

org.verapdf.as.io.ASInputStream

org.verapdf.as.filters.ASInFilter

org.verapdf.as.filters.io.ASBufferingInFilter

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

COSFilterAESDecryptionDefault, COSFilterASCII85Decode, COSFilterASCIIHexDecode, COSFilterFlateDecode, COSFilterLZWDecode, COSFilterRC4DecryptionDefault, COSPredictorDecode, EexecFilterDecode

public class ASBufferingInFilter
extends ASInFilter

Class provides buffered input from input stream.

Author:

Sergey Shemyakov

Field Summary

Fields

Modifier and Type	Field and Description
static int	BF_BUFFER_SIZE
protected byte[]	internalBuffer

Fields inherited from class org.verapdf.as.io.ASInputStream

nPos, resourceUsers

Constructor Summary

Constructors

Constructor and Description
ASBufferingInFilter(ASBufferingInFilter filter)
ASBufferingInFilter(ASInputStream stream)
ASBufferingInFilter(ASInputStream stream, int buffCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
long	addToBuffer(int bytesToAdd) Reads next portion of data from the underlying stream and appends it to the end of data, contained in internal buffer.
byte	bufferPop() Returns the character pointed by buffer begin marker and advances it.
int	bufferPopArray(byte[] buffer, int read) Reads data from internal buffer into passed byte array and advances begin marker.
int	bufferSize()
void	closeResource()
static byte[]	concatenate(byte[] one, int lengthOne, byte[] two, int lengthTwo)
protected void	decode()
long	feedBuffer(int bytesToRead) Reads next portion of data from the underlying stream to the internal buffer, updates begin and end pointers and returns number of bytes actually placed in buffer.
int	getBufferBegin()
int	getBufferCapacity()
int	getBufferEnd()
int	processBuffer(int bytesToProcess) Shifts begin marker by up to bytesToProceed bytes to the right of to the end of the buffer if bytesToProceed is too big.
void	reset()
int	skip(int size) Skips given number of decoded bytes in stream.

Methods inherited from class org.verapdf.as.filters.ASInFilter

close, getInputStream, incrementResourceUsers, read, read, read, setInputStream

Methods inherited from class org.verapdf.as.io.ASInputStream

createStreamFromStream

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, skip

Methods inherited from class java.lang.Object

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

Field Detail

BF_BUFFER_SIZE

public static final int BF_BUFFER_SIZE

See Also:

Constant Field Values

internalBuffer

protected byte[] internalBuffer

Constructor Detail

ASBufferingInFilter

public ASBufferingInFilter(ASInputStream stream)
                    throws IOException

Throws:

IOException

ASBufferingInFilter

public ASBufferingInFilter(ASInputStream stream,
                   int buffCapacity)
                    throws IOException

Throws:

IOException

ASBufferingInFilter

public ASBufferingInFilter(ASBufferingInFilter filter)

Method Detail

processBuffer

public int processBuffer(int bytesToProcess)

Shifts begin marker by up to bytesToProceed bytes to the right of to the end of the buffer if bytesToProceed is too big.

Parameters:

bytesToProcess - amount of bytes to shift.

Returns:

amount of bytes actually processed.

feedBuffer

public long feedBuffer(int bytesToRead)
                throws IOException

Reads next portion of data from the underlying stream to the internal buffer, updates begin and end pointers and returns number of bytes actually placed in buffer.

Parameters:

bytesToRead - amount of bytes to read.

Returns:

amount of bytes actually placed into buffer.

Throws:

IOException

addToBuffer

public long addToBuffer(int bytesToAdd)
                 throws IOException

Reads next portion of data from the underlying stream and appends it to the end of data, contained in internal buffer.

Parameters:

bytesToAdd - amount of bytes to read.

Returns:

amount of bytes actually appended to buffer.

Throws:

IOException

getBufferBegin

public int getBufferBegin()

Returns:

beginning index of unread data in buffer.

getBufferEnd

public int getBufferEnd()

Returns:

index of the end of of valid unread data in buffer.

bufferPop

public byte bufferPop()

Returns the character pointed by buffer begin marker and advances it.

Returns:

character, pointed by buffer begin marker.

bufferPopArray

public int bufferPopArray(byte[] buffer,
                 int read)
                   throws IOException

Reads data from internal buffer into passed byte array and advances begin marker.

Parameters:

buffer - is byte array where data will be read.

read - maximal amount of bytes to read.

Returns:

amount of actually read bytes.

Throws:

IOException - if passed buffer is too small to contain necessary amount of bytes.

bufferSize

public int bufferSize()

Returns:

the number of bytes currently available in the buffer.

getBufferCapacity

public int getBufferCapacity()

Returns:

the total capacity of buffer.

closeResource

public void closeResource()
                   throws IOException

Overrides:

closeResource in class ASInFilter

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class ASInFilter

Throws:

IOException

concatenate

public static byte[] concatenate(byte[] one,
                 int lengthOne,
                 byte[] two,
                 int lengthTwo)

decode

protected void decode()
               throws IOException

Throws:

IOException

skip

public int skip(int size)
         throws IOException

Skips given number of decoded bytes in stream.

Overrides:

skip in class ASInFilter

Parameters:

size - is amount of bytes to skip.

Returns:

amount of actually skipped bytes.

Throws:

IOException - if stream-reading error occurs.