com.devexperts.io

Class ChunkedInput

java.lang.Object

java.io.InputStream

com.devexperts.io.BufferedInput

com.devexperts.io.ChunkedInput

All Implemented Interfaces:

Closeable, DataInput, ObjectInput, AutoCloseable

public final class ChunkedInput
extends BufferedInput

Implementation of BufferedInput using ChunkList as an input.

Field Summary

Fields inherited from class com.devexperts.io.BufferedInput

buffer, EMPTY_BYTE_ARRAY, limit, markPosition, position, totalPositionBase

Constructor Summary

Constructors

Constructor and Description
ChunkedInput() Constructs new chunked input with default pool.
ChunkedInput(ChunkPool pool) Constructs new chunked input with a specified pool to acquire chunk list from..

Method Summary

Modifier and Type	Method and Description
void	addAllToInput(ChunkList chunkList, Object owner) Adds specified chunks to the input.
void	addToInput(byte[] bytes, int offset, int length) Adds specified bytes to the input.
void	addToInput(Chunk chunk, Object owner) Adds specified chunk to the input.
int	available() Returns the number of bytes that can be read without blocking.
void	clear() Clears this chunked input, invalidates the mark and recycles all contained chunks.
boolean	hasAvailable() Checks if more bytes can be read from this input.
boolean	hasAvailable(int bytes) Checks if the specified number of bytes can be read from this input.
void	mark() Marks the current position in this buffered input.
int	read(byte[] b, int off, int len)
protected int	readData() This method is invoked when input methods need more bytes to read data.
void	rewind(long n) Rewinds specified number of bytes.
String	toString() Returns a string representation of the object.
void	unmark() Invalidates mark position in this buffered input.

Methods inherited from class com.devexperts.io.BufferedInput

checkEncapsulatedLength, checkEOB, checkRewind, mark, mark, markSupported, needData, read, read, readBoolean, readByte, readByteArray, readChar, readCompactInt, readCompactLong, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readMarshalled, readMarshalled, readObject, readObject, readObject, readShort, readToByteBuffer, readToDataOutput, readToOutputStream, readUnsignedByte, readUnsignedShort, readUTF, readUTFBody, readUTFChar, readUTFString, reset, seek, skip, skipBytes, throwEOFException, totalPosition

Methods inherited from class java.io.InputStream

close

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.ObjectInput

close

Constructor Detail

ChunkedInput

public ChunkedInput()

Constructs new chunked input with default pool.

ChunkedInput

public ChunkedInput(ChunkPool pool)

Constructs new chunked input with a specified pool to acquire chunk list from..

Method Detail

clear

public void clear()

Clears this chunked input, invalidates the mark and recycles all contained chunks. The totalPosition is reset to 0.

addToInput

public void addToInput(byte[] bytes,
                       int offset,
                       int length)

Adds specified bytes to the input.

Parameters:

bytes - the bytes.

offset - offset in the bytes.

length - the length.

addToInput

public void addToInput(Chunk chunk,
                       Object owner)

Adds specified chunk to the input.

Parameters:

chunk - the chunk to be added

owner - owner of the chunk

Throws:

IllegalStateException - if the given chunk is not read-only and its owner differs from the one specified

addAllToInput

public void addAllToInput(ChunkList chunkList,
                          Object owner)

Adds specified chunks to the input.

Parameters:

chunkList - the chunk list with chunks to be added

owner - owner of the chunks

Throws:

IllegalStateException - if the given chunk is not read-only and its owner differs from the one specified

hasAvailable

public boolean hasAvailable()

Checks if more bytes can be read from this input. This is a faster-working shortcut for available() > 0 check. This implementation returns hasAvailable(1)

Overrides:

hasAvailable in class BufferedInput

Returns:

true if more bytes can be read from this input.

hasAvailable

public boolean hasAvailable(int bytes)

Checks if the specified number of bytes can be read from this input. This is a faster-working shortcut for available() >= bytes check. This implementation returns available() >= bytes

Overrides:

hasAvailable in class BufferedInput

Parameters:

bytes - the number of bytes.

Returns:

true if the specified number of bytes can be read from this input.

available

public int available()

Returns the number of bytes that can be read without blocking.

Specified by:

available in interface ObjectInput

Overrides:

available in class BufferedInput

Returns:

the number of available bytes.

read

public int read(byte[] b,
                int off,
                int len)

Specified by:

read in interface ObjectInput

Overrides:

read in class BufferedInput

mark

public void mark()

Marks the current position in this buffered input. A subsequent call to the reset method repositions this input at the last marked position so that subsequent reads re-read the same bytes. A subsequent call to unmark method invalidates mark without changing input position.

Overrides:

mark in class BufferedInput

unmark

public void unmark()

Invalidates mark position in this buffered input. This method does nothing is this input was not marked.

Overrides:

unmark in class BufferedInput

rewind

public void rewind(long n)
            throws IllegalStateException

Rewinds specified number of bytes. The input cannot be rewound past the marked position.

Specified by:

rewind in class BufferedInput

Parameters:

n - the number of bytes to rewind

Throws:

IllegalStateException - if this stream is not marked or if attempting to rewind past the marked position

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object.

readData

protected int readData()

Description copied from class: BufferedInput

This method is invoked when input methods need more bytes to read data. This method shall make an attempt to read some bytes into the buffer. This method returns number of bytes actually read or value -1 if no bytes can be read because the end of the stream has been reached. This method may block if needed. This method is allowed to update buffer, position, limit and totalPositionBase fields as needed.

This method shall never throw an EOFException.

Specified by:

readData in class BufferedInput

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached