com.devexperts.io

Class StreamInput

java.lang.Object

java.io.InputStream

com.devexperts.io.BufferedInput

com.devexperts.io.StreamInput

All Implemented Interfaces:

Closeable, DataInput, ObjectInput, AutoCloseable

public class StreamInput
extends BufferedInput

An implementation of BufferedInput that reads all data from source InputStream.

Field Summary

Fields

Modifier and Type	Field and Description
protected InputStream	in

Fields inherited from class com.devexperts.io.BufferedInput

buffer, EMPTY_BYTE_ARRAY, limit, markPosition, position, totalPositionBase

Constructor Summary

Constructors

Constructor and Description
StreamInput() Creates a new stream input with default buffer size.
StreamInput(InputStream in) Creates a new stream input with specified source input stream and default buffer size.
StreamInput(InputStream in, int size) Creates a new stream input with specified source input stream and buffer size.
StreamInput(int size) Creates a new stream input with specified buffer size.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes that can be read without blocking.
void	close() Closes the source input stream and resets this StreamInput with resetInput method.
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.
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	resetInput() Resets this stream input by releasing source input stream and resetting position.
void	rewind(long n) Rewinds specified number of bytes.
void	setInput(InputStream in) Sets new source input stream.
long	skip(long n)
protected void	throwEOFException() Throws EOFException when requested by BufferedInput.needData() method.

Methods inherited from class com.devexperts.io.BufferedInput

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

Methods inherited from class java.lang.Object

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

Field Detail

in

protected InputStream in

Constructor Detail

StreamInput

public StreamInput()

Creates a new stream input with default buffer size.

StreamInput

public StreamInput(int size)

Creates a new stream input with specified buffer size.

Parameters:

size - the initial buffer size

Throws:

IllegalArgumentException - if size is not positive

StreamInput

public StreamInput(InputStream in)

Creates a new stream input with specified source input stream and default buffer size.

Parameters:

in - the source to read from

StreamInput

public StreamInput(InputStream in,
                   int size)

Creates a new stream input with specified source input stream and buffer size.

Parameters:

in - the source to read from

size - the initial buffer size

Throws:

IllegalArgumentException - if size is not positive

Method Detail

setInput

public void setInput(InputStream in)

Sets new source input stream. Accepts null to release source.

Parameters:

in - the source to read from

resetInput

public void resetInput()

Resets this stream input by releasing source input stream and resetting position.

close

public void close()
           throws IOException

Closes the source input stream and resets this StreamInput with resetInput method.

Specified by:

close in interface Closeable

Specified by:

close in interface ObjectInput

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException - if an I/O error occurs.

hasAvailable

public boolean hasAvailable()
                     throws IOException

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.

Throws:

IOException - if an I/O error occurs.

hasAvailable

public boolean hasAvailable(int bytes)
                     throws IOException

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.

Throws:

IOException - if an I/O error occurs.

available

public int available()
              throws IOException

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.

Throws:

IOException - If an I/O error has occurred.

read

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

Specified by:

read in interface ObjectInput

Overrides:

read in class BufferedInput

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Specified by:

skip in interface ObjectInput

Overrides:

skip in class BufferedInput

Throws:

IOException

rewind

public void rewind(long n)

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

readData

protected int readData()
                throws IOException

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

Throws:

IOException - if an I/O error occurs

throwEOFException

protected void throwEOFException()
                          throws EOFException

Description copied from class: BufferedInput

Throws EOFException when requested by BufferedInput.needData() method. This implementation throws same reused instance with truncated stack trace to avoid garbage.

Overrides:

throwEOFException in class BufferedInput

Throws:

EOFException