Package net.officefloor.server.stream

Class StreamBuffer<B>

java.lang.Object

net.officefloor.server.stream.StreamBuffer<B>

Type Parameters:

B - Type of buffer.

Direct Known Subclasses:

AbstractStreamBufferPool.FileStreamBuffer, AbstractStreamBufferPool.UnpooledStreamBuffer, NettyBufferPool, VertxBufferPool

public abstract class StreamBuffer<B>
extends Object

Buffer that is part of a stream.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamBuffer.FileBuffer	FileChannel content buffer.

Field Summary

Fields

Modifier and Type	Field	Description
final StreamBuffer.FileBuffer	fileBuffer	Obtains the StreamBuffer.FileBuffer.
StreamBuffer<B>	next	Next StreamBuffer in the stream.
final B	pooledBuffer	Obtains the pooled buffer.
final ByteBuffer	unpooledByteBuffer	Obtains the non-pooled ByteBuffer.

Constructor Summary

Constructors

Constructor	Description
StreamBuffer(B pooledBuffer, ByteBuffer unpooledByteBuffer, StreamBuffer.FileBuffer fileBuffer)	Instantiate.

Method Summary

Modifier and Type	Method	Description
static <B> Appendable	getAppendable(StreamBuffer<B> headBuffer, StreamBufferPool<B> bufferPool)	Obtains an Appendable to write to the StreamBuffer stream.
static <B> StreamBuffer<B>	getWriteStreamBuffer(StreamBuffer<B> headBuffer, StreamBufferPool<B> bufferPool)	Obtains the StreamBuffer to use for writing.
abstract void	release()	Releases this StreamBuffer for re-use.
abstract boolean	write(byte datum)	Writes a byte to the pooled buffer.
int	write(byte[] data)	Writes all the data to the pooled buffer.
abstract int	write(byte[] data, int offset, int length)	Writes the data to the pooled buffer.
static <B> void	write(byte[] bytes, int offset, int length, StreamBuffer<B> headBuffer, StreamBufferPool<B> bufferPool)	Writes the bytes to the StreamBuffer stream.
static <B> void	write(byte[] bytes, StreamBuffer<B> headBuffer, StreamBufferPool<B> bufferPool)	Writes all the bytes to the StreamBuffer stream.
static <B> void	write(long value, StreamBuffer<B> head, StreamBufferPool<B> bufferPool)	Writes a long value to the StreamBuffer.
static <B> void	write(CharSequence characters, int offset, int length, StreamBuffer<B> headBuffer, StreamBufferPool<B> bufferPool)	Writes the CharSequence to the StreamBuffer stream.
static <B> void	write(CharSequence characters, StreamBuffer<B> headBuffer, StreamBufferPool<B> bufferPool)	Writes all the CharSequence to the StreamBuffer stream.
static <B> StreamBuffer<B>	writeByte(byte character, StreamBuffer<B> writeBuffer, StreamBufferPool<B> bufferPool)	Writes a HTTP encoded character.

Methods inherited from class java.lang.Object

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

Field Details

pooledBuffer

public final B pooledBuffer

Obtains the pooled buffer. Will be null if not pooled.

unpooledByteBuffer

public final ByteBuffer unpooledByteBuffer

Obtains the non-pooled ByteBuffer. Will be null if non-pooled.

fileBuffer

public final StreamBuffer.FileBuffer fileBuffer

Obtains the StreamBuffer.FileBuffer. Will be null if not file.

next

public StreamBuffer<B> next

Next StreamBuffer in the stream.

This allows chaining StreamBuffer instances into a linked list (and avoids memory management overheads of creating/destroying lists).

Constructor Details

StreamBuffer

public StreamBuffer(B pooledBuffer,
 ByteBuffer unpooledByteBuffer,
 StreamBuffer.FileBuffer fileBuffer)

Instantiate.

Parameters:

pooledBuffer - Pooled buffer. Must be null if another buffer provided.

unpooledByteBuffer - Unpooled ByteBuffer. Must be null if another buffer provided.

fileBuffer - StreamBuffer.FileBuffer. Must be null if another buffer provided.

Throws:

IllegalArgumentException - If not providing the one buffer.

Method Details

write

public static <B> void write(byte[] bytes,
 StreamBuffer<B> headBuffer,
 StreamBufferPool<B> bufferPool)

Writes all the bytes to the StreamBuffer stream.

Type Parameters:

B - Buffer type.

Parameters:

bytes - Bytes to be written to the StreamBuffer stream.

headBuffer - Head StreamBuffer in the linked list of StreamBuffer instances.

bufferPool - StreamBufferPool should additional StreamBuffer instances be required in writing the bytes.

write

public static <B> void write(byte[] bytes,
 int offset,
 int length,
 StreamBuffer<B> headBuffer,
 StreamBufferPool<B> bufferPool)

Writes the bytes to the StreamBuffer stream.

Type Parameters:

B - Buffer type.

Parameters:

bytes - Bytes to be written to the StreamBuffer stream.

offset - Offset into the bytes to start writing.

length - Length of bytes to write.

headBuffer - Head StreamBuffer in the linked list of StreamBuffer instances.

bufferPool - StreamBufferPool should additional StreamBuffer instances be required in writing the bytes.

write

public static <B> void write(CharSequence characters,
 StreamBuffer<B> headBuffer,
 StreamBufferPool<B> bufferPool)

Writes all the CharSequence to the StreamBuffer stream.

Type Parameters:

B - Buffer type.

Parameters:

characters - Characters to be written to the StreamBuffer stream.

headBuffer - Head StreamBuffer in the linked list of StreamBuffer instances.

bufferPool - StreamBufferPool should additional StreamBuffer instances be required in writing the bytes.

write

public static <B> void write(CharSequence characters,
 int offset,
 int length,
 StreamBuffer<B> headBuffer,
 StreamBufferPool<B> bufferPool)

Writes the CharSequence to the StreamBuffer stream.

Type Parameters:

B - Buffer type.

Parameters:

characters - Characters to be written to the StreamBuffer stream.

offset - Offset into the CharSequence to start writing.

length - Length of characters to write.

headBuffer - Head StreamBuffer in the linked list of StreamBuffer instances.

bufferPool - StreamBufferPool should additional StreamBuffer instances be required in writing the bytes.

write

public static <B> void write(long value,
 StreamBuffer<B> head,
 StreamBufferPool<B> bufferPool)

Writes a long value to the StreamBuffer.

Type Parameters:

B - Buffer type.

Parameters:

value - Long value to write to the StreamBuffer.

head - Head StreamBuffer of linked list of StreamBuffer instances.

bufferPool - StreamBufferPool.

getAppendable

public static <B> Appendable getAppendable(StreamBuffer<B> headBuffer,
 StreamBufferPool<B> bufferPool)

Obtains an Appendable to write to the StreamBuffer stream.

Typical use of this is for the DateTimeFormatter.

Type Parameters:

B - Buffer type.

Parameters:

headBuffer - Head StreamBuffer in the linked list of StreamBuffer instances.

bufferPool - StreamBufferPool should additional StreamBuffer instances be required in writing the bytes.

Returns:

Appendable to write to the StreamBuffer stream.

getWriteStreamBuffer

public static <B> StreamBuffer<B> getWriteStreamBuffer(StreamBuffer<B> headBuffer,
 StreamBufferPool<B> bufferPool)

Obtains the StreamBuffer to use for writing.

Type Parameters:

B - Buffer type.

Parameters:

headBuffer - Head StreamBuffer in the linked list of StreamBuffer instances.

bufferPool - StreamBufferPool should additional StreamBuffer instances be required in writing the bytes.

Returns:

StreamBuffer within the linked list to next write data.

writeByte

public static <B> StreamBuffer<B> writeByte(byte character,
 StreamBuffer<B> writeBuffer,
 StreamBufferPool<B> bufferPool)

Writes a HTTP encoded character.

Type Parameters:

B - Buffer type.

Parameters:

character - Character to write.

writeBuffer - Write StreamBuffer.

bufferPool - StreamBufferPool.

Returns:

Next write StreamBuffer.

write

public abstract boolean write(byte datum)

Writes a byte to the pooled buffer.

Parameters:

datum - Byte value.

Returns:

true if written value to buffer. false indicates the pooled buffer is full.

write

public abstract int write(byte[] data,
 int offset,
 int length)

Writes the data to the pooled buffer.

Parameters:

data - Data to write to the pooled buffer.

offset - Offset within the data to write the data.

length - Length of data to write the data.

Returns:

Number of bytes written.

write

public int write(byte[] data)

Writes all the data to the pooled buffer.

Parameters:

data - Data to write to the pooled buffer.

Returns:

Number of bytes written.

release

public abstract void release()

Releases this StreamBuffer for re-use.