org.apache.commons.io.input.buffer

Class CircularBufferInputStream

java.lang.Object

java.io.InputStream

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

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

PeekableInputStream

public class CircularBufferInputStream
extends java.io.InputStream

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

Constructor Summary

Constructors

Constructor and Description
CircularBufferInputStream(java.io.InputStream inputStream) Creates a new instance, which filters the given input stream, and uses a reasonable default buffer size (IOUtils.DEFAULT_BUFFER_SIZE).
CircularBufferInputStream(java.io.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 and 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, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularBufferInputStream

public CircularBufferInputStream(java.io.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(java.io.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 java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] buffer)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException