Module org.glassfish.grizzly

Package org.glassfish.grizzly.memory

Class CompositeBuffer

java.lang.Object

org.glassfish.grizzly.memory.CompositeBuffer

All Implemented Interfaces:

Comparable<Buffer>, WritableMessage, Buffer

Direct Known Subclasses:

BuffersBuffer

public abstract class CompositeBuffer
extends Object
implements Buffer

Author:

Alexey Stashok

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompositeBuffer.BulkOperation	Bulk Buffer operation, responsible for byte-by-byte Buffer processing.
static enum	CompositeBuffer.DisposeOrder	The order in which internal Buffers will be disposed.
static interface	CompositeBuffer.Setter	Setter.

Field Summary

Fields

Modifier and Type	Field	Description
protected CompositeBuffer.DisposeOrder	disposeOrder

Constructor Summary

Constructors

Constructor	Description
CompositeBuffer()

Method Summary

Modifier and Type	Method	Description
abstract boolean	allowInternalBuffersDispose()
abstract void	allowInternalBuffersDispose(boolean allow)
abstract CompositeBuffer	append(Buffer buffer)
abstract int	bulk(CompositeBuffer.BulkOperation operation)	Iterates over Buffer bytes from Buffer.position() to Buffer.limit() and lets CompositeBuffer.BulkOperation examine/change the buffer content;
abstract int	bulk(CompositeBuffer.BulkOperation operation, int position, int limit)	Iterates over Buffer bytes from position to limit and lets CompositeBuffer.BulkOperation examine/change the buffer content;
CompositeBuffer.DisposeOrder	disposeOrder()	Returns the order in which internal Buffers will be disposed.
CompositeBuffer	disposeOrder(CompositeBuffer.DisposeOrder disposeOrder)	Sets the order in which internal Buffers will be disposed.
static CompositeBuffer	newBuffer()	Construct CompositeBuffer.
static CompositeBuffer	newBuffer(MemoryManager memoryManager)
static CompositeBuffer	newBuffer(MemoryManager memoryManager, Buffer... buffers)
static CompositeBuffer	newBuffer(MemoryManager memoryManager, Buffer[] buffers, boolean isReadOnly)
abstract CompositeBuffer	prepend(Buffer buffer)	Prepend data from header.position() to header.limit() to the current buffer.
abstract void	removeAll()	Removes underlying Buffers, without disposing
abstract boolean	replace(Buffer oldBuffer, Buffer newBuffer)	Replace one internal Buffer with another one.
abstract Object[]	underlying()	Return the underlying buffer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.glassfish.grizzly.Buffer

allowBufferDispose, allowBufferDispose, array, arrayOffset, asReadOnlyBuffer, capacity, clear, compact, dispose, dumpHex, duplicate, flip, get, get, get, get, get, get, getChar, getChar, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getShort, getShort, hasArray, hasRemaining, isComposite, isDirect, isReadOnly, limit, limit, mark, order, order, position, position, put, put, put, put, put, put, put, put, put8BitString, putChar, putChar, putDouble, putDouble, putFloat, putFloat, putInt, putInt, putLong, putLong, putShort, putShort, remaining, reset, rewind, shrink, slice, slice, split, toBufferArray, toBufferArray, toBufferArray, toBufferArray, toByteBuffer, toByteBuffer, toByteBufferArray, toByteBufferArray, toByteBufferArray, toByteBufferArray, toStringContent, toStringContent, toStringContent, trim, tryDispose

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.glassfish.grizzly.asyncqueue.WritableMessage

isExternal, release

Field Details

disposeOrder

protected CompositeBuffer.DisposeOrder disposeOrder

Constructor Details

CompositeBuffer

public CompositeBuffer()

Method Details

newBuffer

public static CompositeBuffer newBuffer()

Construct CompositeBuffer.

Returns:

new CompositeBuffer

newBuffer

public static CompositeBuffer newBuffer(MemoryManager memoryManager)

newBuffer

public static CompositeBuffer newBuffer(MemoryManager memoryManager,
 Buffer... buffers)

newBuffer

public static CompositeBuffer newBuffer(MemoryManager memoryManager,
 Buffer[] buffers,
 boolean isReadOnly)

disposeOrder

public CompositeBuffer.DisposeOrder disposeOrder()

Returns the order in which internal Buffers will be disposed.

Returns:

CompositeBuffer.DisposeOrder

disposeOrder

public CompositeBuffer disposeOrder(CompositeBuffer.DisposeOrder disposeOrder)

Sets the order in which internal Buffers will be disposed.

Parameters:

disposeOrder -

Returns:

this buffer

append

public abstract CompositeBuffer append(Buffer buffer)

prepend

public abstract CompositeBuffer prepend(Buffer buffer)

Description copied from interface: Buffer

Prepend data from header.position() to header.limit() to the current buffer. This will change the value returned by buffer()!

Specified by:

prepend in interface Buffer

Parameters:

buffer - the data to prepend

Returns:

the new buffer

underlying

public abstract Object[] underlying()

Description copied from interface: Buffer

Return the underlying buffer

Specified by:

underlying in interface Buffer

Returns:

the underlying buffer

removeAll

public abstract void removeAll()

Removes underlying Buffers, without disposing

allowInternalBuffersDispose

public abstract void allowInternalBuffersDispose(boolean allow)

allowInternalBuffersDispose

public abstract boolean allowInternalBuffersDispose()

bulk

public abstract int bulk(CompositeBuffer.BulkOperation operation)

Iterates over Buffer bytes from Buffer.position() to Buffer.limit() and lets CompositeBuffer.BulkOperation examine/change the buffer content;

Parameters:

operation - CompositeBuffer.BulkOperation

Returns:

Buffer position the processing was stopped on, or -1, if processing reached the limit.

bulk

public abstract int bulk(CompositeBuffer.BulkOperation operation,
 int position,
 int limit)

Iterates over Buffer bytes from position to limit and lets CompositeBuffer.BulkOperation examine/change the buffer content;

Parameters:

operation - CompositeBuffer.BulkOperation

Returns:

Buffer position the processing was stopped on, or -1, if processing reached the limit.

replace

public abstract boolean replace(Buffer oldBuffer,
 Buffer newBuffer)

Replace one internal Buffer with another one.

Parameters:

oldBuffer - the Buffer to replace.

newBuffer - the new Buffer.

Returns:

true, if the oldBuffer was found and replaced, or false otherwise.