org.jadira.lang.io.buffered

Class BytesBufferedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.jadira.lang.io.buffered.AbstractBufferedOutputStream

org.jadira.lang.io.buffered.BytesBufferedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BytesBufferedOutputStream
extends AbstractBufferedOutputStream

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

Field Summary

Fields inherited from class org.jadira.lang.io.buffered.AbstractBufferedOutputStream

DEFAULT_BUFFER_SIZE

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
BytesBufferedOutputStream(OutputStream out) Creates a new instance with the default buffer size
BytesBufferedOutputStream(OutputStream out, int size) Creates a new instance with the given buffer size in bytes.
BytesBufferedOutputStream(OutputStream out, int size, boolean useNativeByteOrder) Creates a new instance with the given buffer size in bytes.
BytesBufferedOutputStream(OutputStream out, int size, ByteOrder byteOrder) Creates a new instance with the given buffer size in bytes.

Method Summary

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

Methods inherited from class org.jadira.lang.io.buffered.AbstractBufferedOutputStream

close, flush, write, write

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

Constructor Detail

BytesBufferedOutputStream

public BytesBufferedOutputStream(OutputStream out)

Creates a new instance with the default buffer size

Parameters:

out - OutputStream to be decorated

See Also:

BufferedOutputStream.BufferedOutputStream(OutputStream)

BytesBufferedOutputStream

public BytesBufferedOutputStream(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)

BytesBufferedOutputStream

public BytesBufferedOutputStream(OutputStream out,
                                 int size,
                                 boolean useNativeByteOrder)

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

useNativeByteOrder - If true, native byte ordering will be used

See Also:

BufferedOutputStream.BufferedOutputStream(OutputStream, int)

BytesBufferedOutputStream

public BytesBufferedOutputStream(OutputStream out,
                                 int size,
                                 ByteOrder byteOrder)

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

byteOrder - Explicitly configure the byte order to be used.

See Also:

BufferedOutputStream.BufferedOutputStream(OutputStream, int)

Method Detail

bytes

protected byte[] bytes()

Description copied from class: AbstractBufferedOutputStream

Return the bytes in the buffer as a byte array

Specified by:

bytes in class AbstractBufferedOutputStream

Returns:

The bytes

put

protected void put(byte b)

Description copied from class: AbstractBufferedOutputStream

Put a single byte into the buffer

Specified by:

put in class AbstractBufferedOutputStream

Parameters:

b - The byte

put

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

Description copied from class: AbstractBufferedOutputStream

Puts bytes into the buffer

Specified by:

put in class AbstractBufferedOutputStream

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 int limit()

Description copied from class: AbstractBufferedOutputStream

Returns the limit of the buffer

Specified by:

limit in class AbstractBufferedOutputStream

Returns:

The limit

clean

protected void clean()

Description copied from class: AbstractBufferedOutputStream

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

Specified by:

clean in class AbstractBufferedOutputStream