net.lenni0451.commons.io.stream

Class SequentialInputStream

java.lang.Object

java.io.InputStream

net.lenni0451.commons.io.stream.SequentialInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class SequentialInputStream
extends java.io.InputStream

An InputStream that allows appending data to the stream.
The stream will block if no data is available until new data is appended or the stream is closed.
To ensure thread safety, all methods are synchronized internally.

Constructor Summary

Constructors

Constructor and Description
SequentialInputStream() Create a new SequentialInputStream with default initial capacity and growth factor.
SequentialInputStream(float growthFactor) Create a new SequentialInputStream with the given growth factor and default initial capacity.
SequentialInputStream(int initialCapacity) Create a new SequentialInputStream with the given initial capacity and default growth factor.
SequentialInputStream(int initialCapacity, float growthFactor) Create a new SequentialInputStream with the given initial capacity and growth factor.

Method Summary

Modifier and Type	Method and Description
void	append(byte[] bytes) Append data to the stream. If the internal buffer is full, it will be resized according to the growth factor.
void	close() Close the stream. Any blocked read operations will be unblocked and return -1 if no more data is available.
void	close(java.lang.Throwable error) Close the stream with an error. Any blocked read operations will be unblocked and throw an IOException with the given error as cause.
boolean	isClosed()
int	read() Read a single byte from the stream. This method will block if no data is available until new data is appended or the stream is closed.
int	read(byte[] b, int off, int len) Read bytes from the stream into the given buffer. This method will block if no data is available until new data is appended or the stream is closed.

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

SequentialInputStream

public SequentialInputStream()

Create a new SequentialInputStream with default initial capacity and growth factor.

SequentialInputStream

public SequentialInputStream(int initialCapacity)

Create a new SequentialInputStream with the given initial capacity and default growth factor.

Parameters:

initialCapacity - The initial capacity of the internal buffer (must be >= 0)

SequentialInputStream

public SequentialInputStream(float growthFactor)

Create a new SequentialInputStream with the given growth factor and default initial capacity.

Parameters:

growthFactor - The growth factor of the internal buffer when it needs to grow (must be >= 1)

SequentialInputStream

public SequentialInputStream(int initialCapacity,
                             float growthFactor)

Create a new SequentialInputStream with the given initial capacity and growth factor.

Parameters:

initialCapacity - The initial capacity of the internal buffer (must be >= 0)

growthFactor - The growth factor of the internal buffer when it needs to grow (must be >= 1)

Method Detail

isClosed

public boolean isClosed()

Returns:

If the stream is closed

append

public void append(byte[] bytes)

Append data to the stream.
If the internal buffer is full, it will be resized according to the growth factor.

Parameters:

bytes - The data to append

Throws:

java.lang.NullPointerException - If bytes is null

java.lang.IllegalStateException - If the stream is closed

read

public int read()
         throws java.io.IOException

Read a single byte from the stream.
This method will block if no data is available until new data is appended or the stream is closed.

Specified by:

read in class java.io.InputStream

Returns:

The read byte or -1 if the stream is closed and no more data is available

Throws:

java.io.IOException - If an I/O error occurs

read

public int read(@Nonnull
                byte[] b,
                int off,
                int len)
         throws java.io.IOException

Read bytes from the stream into the given buffer.
This method will block if no data is available until new data is appended or the stream is closed.

Overrides:

read in class java.io.InputStream

Parameters:

b - The buffer into which the data is read

off - The start offset in array b at which the data is written

len - The maximum number of bytes to read

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:

java.io.IOException - If an I/O error occurs

close

public void close()

Close the stream.
Any blocked read operations will be unblocked and return -1 if no more data is available.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

close

public void close(java.lang.Throwable error)

Close the stream with an error.
Any blocked read operations will be unblocked and throw an IOException with the given error as cause.

Parameters:

error - The error that caused the stream to close