Package org.apache.commons.io.input.buffer

Class CircularBufferInputStream

java.lang.Object

java.io.InputStream

org.apache.commons.io.input.buffer.CircularBufferInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

PeekableInputStream

public class CircularBufferInputStream
extends InputStream

Implements a buffered input stream, which is internally based on a CircularByteBuffer. Unlike the BufferedInputStream, this one doesn't need to reallocate byte arrays internally.

Constructor Summary

Constructors

Constructor	Description
CircularBufferInputStream(InputStream inputStream)	Creates a new instance, which filters the given input stream, and uses a reasonable default buffer size (IOUtils.DEFAULT_BUFFER_SIZE).
CircularBufferInputStream(InputStream inputStream, int bufferSize)	Creates a new instance, which filters the given input stream, and uses the given buffer size.

Method Summary

Modifier and Type	Method	Description
void	close()
int	read()
int	read(byte[] buffer)
int	read(byte[] targetBuffer, int offset, int length)

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularBufferInputStream

public CircularBufferInputStream(InputStream inputStream,
                                 int bufferSize)

Creates a new instance, which filters the given input stream, and uses the given buffer size.

Parameters:

inputStream - The input stream, which is being buffered.

bufferSize - The size of the CircularByteBuffer, which is used internally.

CircularBufferInputStream

public CircularBufferInputStream(InputStream inputStream)

Creates a new instance, which filters the given input stream, and uses a reasonable default buffer size (IOUtils.DEFAULT_BUFFER_SIZE).

Parameters:

inputStream - The input stream, which is being buffered.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buffer)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] targetBuffer,
                int offset,
                int length)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException