org.jadira.lang.io.buffered

Class AbstractBufferedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.jadira.lang.io.buffered.AbstractBufferedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

ByteArrayBufferedOutputStream, BytesBufferedOutputStream, DirectBytesBufferedOutputStream

public abstract class AbstractBufferedOutputStream
extends FilterOutputStream

Provides the basic structure for implementing BufferedOutputStreams. Subclasses typically differ in terms of how they provide the buffer. Some of the functionality needs to be effectively reproduced from BufferedOutputStream - 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.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
AbstractBufferedOutputStream(OutputStream out) A BufferedOutputStream where the buffer is provided by a byte array.
AbstractBufferedOutputStream(OutputStream out, int size) Creates a new instance with the given buffer size in bytes.

Method Summary

Modifier and Type	Method and Description
protected abstract byte[]	bytes() Return the bytes in the buffer as a byte array
protected abstract void	clean() Performs any necessary cleaning of the buffer and releasing of resources.
void	close()
void	flush()
protected abstract int	limit() Returns the limit of the buffer
protected abstract void	put(byte b) Put a single byte into the buffer
protected abstract void	put(int count, byte[] b, int off, int len) Puts bytes into the buffer
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.FilterOutputStream

write

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

AbstractBufferedOutputStream

public AbstractBufferedOutputStream(OutputStream out)

A BufferedOutputStream where the buffer is provided by a byte array. Use this class as an alternative to BufferedOutputStream

Parameters:

out - OutputStream to be decorated

AbstractBufferedOutputStream

public AbstractBufferedOutputStream(OutputStream out,
                                    int size)

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

Parameters:

out - OutputStream to be decorated

size - The size of the buffer in bytes

See Also:

BufferedOutputStream.BufferedOutputStream(OutputStream, int)

Method Detail

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

BufferedOutputStream.write(int)

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

See Also:

BufferedOutputStream.write(byte[], int, int)

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

See Also:

BufferedOutputStream.flush()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterOutputStream

Throws:

IOException

bytes

protected abstract byte[] bytes()

Return the bytes in the buffer as a byte array

Returns:

The bytes

put

protected abstract void put(byte b)

Put a single byte into the buffer

Parameters:

b - The byte

put

protected abstract void put(int count,
                            byte[] b,
                            int off,
                            int len)

Puts bytes into the buffer

Parameters:

count - The number of bytes already written into the buffer

b - The byte array with the bytes to put

off - Offset to write from in the bytes, b

len - The number of bytes to write

limit

protected abstract int limit()

Returns the limit of the buffer

Returns:

The limit

clean

protected abstract void clean()

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