Interface RetainableByteBuffer.Mutable

All Superinterfaces:

Retainable, RetainableByteBuffer

All Known Implementing Classes:

AbstractRetainableByteBuffer, ArrayByteBufferPool.Tracking.TrackedBuffer, RetainableByteBuffer.Abstract, RetainableByteBuffer.DynamicCapacity, RetainableByteBuffer.FixedCapacity, RetainableByteBuffer.NonRetainableByteBuffer, RetainableByteBuffer.Pooled, RetainableByteBuffer.Wrapper

Enclosing interface:

RetainableByteBuffer

public static interface RetainableByteBuffer.Mutable
extends RetainableByteBuffer

Extended RetainableByteBuffer API with mutator methods. The mutator methods come in the following styles:

• put methods are used for putting raw bytes into the buffer and are similar to ByteBuffer.put(byte) etc. Put methods may be used in fluent style.
• add methods are used for handing over an external buffer to be managed by this buffer. External buffers are passed by reference and the caller will not longer manage the added buffer. Add methods may be used in fluent style.
• append methods are used for handing over the content of a buffer to be included in this buffer. The caller may still use the passed buffer and is responsible for eventually releasing it.

Nested Class Summary

Nested classes/interfaces inherited from interface Retainable

Retainable.ReferenceCounter

Nested classes/interfaces inherited from interface RetainableByteBuffer

RetainableByteBuffer.Abstract, RetainableByteBuffer.DynamicCapacity, RetainableByteBuffer.EmptyRetainableByteBuffer, RetainableByteBuffer.FixedCapacity, RetainableByteBuffer.Mutable, RetainableByteBuffer.NonRetainableByteBuffer, RetainableByteBuffer.Pooled, RetainableByteBuffer.Wrapper

Field Summary

Fields inherited from interface Retainable

NON_RETAINABLE

Fields inherited from interface RetainableByteBuffer

EMPTY

Method Summary

Modifier and Type	Method	Description
RetainableByteBuffer.Mutable	add(ByteBuffer bytes)	Add the passed ByteBuffer to this buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	add(RetainableByteBuffer bytes)	Add the passed RetainableByteBuffer to this buffer, growing this buffer if necessary and possible.
boolean	append(ByteBuffer bytes)	Copies the contents of the given byte buffer to the end of this buffer, growing this buffer if necessary and possible.
boolean	append(RetainableByteBuffer bytes)	Retain or copy the contents of the given retainable byte buffer to the end of this buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	put(byte b)	Put a byte to the buffer, growing this buffer if necessary and possible.
default RetainableByteBuffer.Mutable	put(byte[] bytes)	Put a byte array to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	put(byte[] bytes, int offset, int length)	Put a byte array to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	put(long index, byte b)	Put a byte to the buffer at a given index.
RetainableByteBuffer.Mutable	putInt(int i)	Put an int to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	putLong(long l)	Put a long to the buffer, growing this buffer if necessary and possible.
RetainableByteBuffer.Mutable	putShort(short s)	Put a short to the buffer, growing this buffer if necessary and possible.

Methods inherited from interface Retainable

canRetain, getRetained, isRetained, release, retain

Methods inherited from interface RetainableByteBuffer

appendTo, appendTo, asMutable, capacity, clear, copy, get, get, get, getByteBuffer, hasRemaining, isDirect, isEmpty, isFull, isMutable, limit, maxSize, putTo, remaining, size, skip, slice, slice, space, take, take, takeByteArray, takeFrom, toDetailString, writeTo, writeTo

Method Details

add

RetainableByteBuffer.Mutable add(ByteBuffer bytes)
                          throws ReadOnlyBufferException,
BufferOverflowException

Add the passed ByteBuffer to this buffer, growing this buffer if necessary and possible. The source ByteBuffer is passed by reference and the caller gives up "ownership", so implementations of this method may choose to avoid copies by keeping a reference to the buffer.

Parameters:

bytes - the byte buffer to add, which is passed by reference and is not necessarily consumed by the add.

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

BufferOverflowException - if this buffer cannot fit the byte

See Also:

• append(ByteBuffer)

add

RetainableByteBuffer.Mutable add(RetainableByteBuffer bytes)
                          throws ReadOnlyBufferException,
BufferOverflowException

Add the passed RetainableByteBuffer to this buffer, growing this buffer if necessary and possible. The source RetainableByteBuffer is passed by reference and the caller gives up ownership, so implementations of this method may avoid copies by keeping a reference to the buffer. Unlike the similar append(RetainableByteBuffer) and contrary to the general rules of Retainable, implementations of this method need not call Retainable.retain() if keeping a reference, but they must ultimately call Retainable.release() the passed buffer. Callers should use add rather than append(RetainableByteBuffer) if they already have an obligation to release the buffer and wish to delegate that obligation to this buffer.

Parameters:

bytes - the byte buffer to add, which is passed by reference and is not necessarily consumed by the add.

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

BufferOverflowException - if this buffer cannot fit the byte

append

boolean append(ByteBuffer bytes)
        throws ReadOnlyBufferException

Copies the contents of the given byte buffer to the end of this buffer, growing this buffer if necessary and possible.

Parameters:

bytes - the byte buffer to copy from, which is consumed.

Returns:

true if all bytes of the given buffer were copied, false otherwise.

Throws:

ReadOnlyBufferException - if this buffer is read only.

See Also:

• add(ByteBuffer)

append

boolean append(RetainableByteBuffer bytes)
        throws ReadOnlyBufferException

Retain or copy the contents of the given retainable byte buffer to the end of this buffer, growing this buffer if necessary and possible. The implementation will heuristically decide to retain or copy the contents Unlike the similar add(RetainableByteBuffer), implementations of this method must Retainable.retain() the passed buffer if they keep a reference to it.

Parameters:

bytes - the retainable byte buffer to copy from, which is consumed.

Returns:

true if all bytes of the given buffer were copied, false otherwise.

Throws:

ReadOnlyBufferException - if this buffer is read only.

See Also:

• add(RetainableByteBuffer)

put

RetainableByteBuffer.Mutable put(byte b)

Put a byte to the buffer, growing this buffer if necessary and possible.

Parameters:

b - the byte to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

BufferOverflowException - if this buffer cannot fit the byte

putShort

RetainableByteBuffer.Mutable putShort(short s)

Put a short to the buffer, growing this buffer if necessary and possible.

Parameters:

s - the short to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

BufferOverflowException - if this buffer cannot fit the byte

putInt

RetainableByteBuffer.Mutable putInt(int i)

Put an int to the buffer, growing this buffer if necessary and possible.

Parameters:

i - the int to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only

BufferOverflowException - if this buffer cannot fit the byte

putLong

RetainableByteBuffer.Mutable putLong(long l)

Put a long to the buffer, growing this buffer if necessary and possible.

Parameters:

l - the long to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only

BufferOverflowException - if this buffer cannot fit the byte

put

RetainableByteBuffer.Mutable put(byte[] bytes,
 int offset,
 int length)

Put a byte array to the buffer, growing this buffer if necessary and possible.

Parameters:

bytes - the byte array to put

offset - the offset into the array

length - the length in bytes to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only

BufferOverflowException - if this buffer cannot fit the byte

put

default RetainableByteBuffer.Mutable put(byte[] bytes)

Put a byte array to the buffer, growing this buffer if necessary and possible.

Parameters:

bytes - the byte array to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only

BufferOverflowException - if this buffer cannot fit the byte

put

RetainableByteBuffer.Mutable put(long index,
 byte b)

Put a byte to the buffer at a given index.

Parameters:

index - The index relative to the current start of unconsumed data in the buffer.

b - the byte to put

Returns:

this buffer.

Throws:

ReadOnlyBufferException - if this buffer is read only.

BufferOverflowException - if this buffer cannot fit the byte