org.jadira.lang.io.buffered

Class AbstractBufferedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.jadira.lang.io.buffered.AbstractBufferedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ByteArrayBufferedInputStream, BytesBufferedInputStream, DirectBytesBufferedInputStream

public abstract class AbstractBufferedInputStream
extends FilterInputStream

Provides the basic structure for implementing BufferedInputStreams. Subclasses typically differ in terms of how they provide the buffer. Some of the functionality needs to be effectively reproduced from BufferedInputStream - such methods reference the equivalents in that class.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE The default buffer size in bytes

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
AbstractBufferedInputStream(InputStream in) Create a new instance with the default buffer size
AbstractBufferedInputStream(InputStream in, int size) Creates a new instance with the given buffer size in bytes.

Method Summary

Modifier and Type	Method and Description
protected abstract void	assertBufferOpen()
int	available()
protected abstract void	clean() Performs any necessary cleaning of the buffer and releasing of resources.
void	close()
protected abstract void	compact(int markpos, int size) Compact the buffer reducing it to the given size, offset from the given mark position
protected abstract void	get(byte[] b, int pos, int cnt) Retrieve the given number of bytes from the stream
protected abstract int	getInt(int position) Reads four bytes (an int) from the given offset
protected int	getMarkLimit()
boolean	isRestartable() Indicates whether the stream can be restarted
protected abstract int	limit() Returns the buffer's limit
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
protected abstract void	resizeBuffer(int position, int newSize) Enlarge the buffer to the new size, retaining the position
void	restart() Return the stream back to its start position
long	skip(long n)
protected abstract byte[]	toArray() Return the bytes in the buffer as a byte array

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static int DEFAULT_BUFFER_SIZE

The default buffer size in bytes

Constructor Detail

AbstractBufferedInputStream

public AbstractBufferedInputStream(InputStream in)

Create a new instance with the default buffer size

Parameters:

in - InputStream to be wrapped

See Also:

BufferedInputStream.BufferedInputStream(InputStream)

AbstractBufferedInputStream

public AbstractBufferedInputStream(InputStream in,
                                   int size)

Creates a new instance with the given buffer size in bytes.

Parameters:

in - InputStream to be wrapped

size - The size of the buffer in bytes

See Also:

BufferedInputStream.BufferedInputStream(InputStream, int)

Method Detail

assertBufferOpen

protected abstract void assertBufferOpen()
                                  throws IOException

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

BufferedInputStream.read()

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

See Also:

BufferedInputStream.read(byte[], int, int)

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

See Also:

BufferedInputStream.skip(long)

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

See Also:

BufferedInputStream.available()

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

See Also:

BufferedInputStream.mark(int)

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

See Also:

BufferedInputStream.reset()

markSupported

public boolean markSupported()

Overrides:

markSupported in class FilterInputStream

See Also:

BufferedInputStream.markSupported()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException

See Also:

BufferedInputStream.close()

isRestartable

public boolean isRestartable()

Indicates whether the stream can be restarted

Returns:

true if the stream can be restarted

restart

public void restart()
             throws IOException

Return the stream back to its start position

Throws:

IOException - Indicates a problem occurred (e.g. the stream was closed)

compact

protected abstract void compact(int markpos,
                                int size)

Compact the buffer reducing it to the given size, offset from the given mark position

Parameters:

markpos - The mark position to use as the start of the buffer

size - Required buffer size

toArray

protected abstract byte[] toArray()

Return the bytes in the buffer as a byte array

Returns:

The bytes

resizeBuffer

protected abstract void resizeBuffer(int position,
                                     int newSize)
                              throws IOException

Enlarge the buffer to the new size, retaining the position

Parameters:

position - The position

newSize - The new size

Throws:

IOException - Indicates a problem resizing

limit

protected abstract int limit()

Returns the buffer's limit

Returns:

The limit

getInt

protected abstract int getInt(int position)
                       throws IOException

Reads four bytes (an int) from the given offset

Parameters:

position - The offset

Returns:

An int

Throws:

IOException - Indicates a problem reading the int

get

protected abstract void get(byte[] b,
                            int pos,
                            int cnt)

Retrieve the given number of bytes from the stream

Parameters:

b - The array into which bytes will be written

pos - The offset within the array of the first byte to be written

cnt - The maximum number of bytes to be written to the given array

clean

protected abstract void clean()

Performs any necessary cleaning of the buffer and releasing of resources.

getMarkLimit

protected int getMarkLimit()