Class RetainableByteBuffer.Wrapper

java.lang.Object

org.eclipse.jetty.io.Retainable.Wrapper

org.eclipse.jetty.io.RetainableByteBuffer.Wrapper

All Implemented Interfaces:

Retainable, RetainableByteBuffer, RetainableByteBuffer.Mutable

Enclosing interface:

RetainableByteBuffer

public static class RetainableByteBuffer.Wrapper
extends Retainable.Wrapper
implements RetainableByteBuffer.Mutable

A wrapper for RetainableByteBuffer instances

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.Retainable

Retainable.ReferenceCounter, Retainable.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.io.RetainableByteBuffer

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

Field Summary

Fields inherited from interface org.eclipse.jetty.io.Retainable

NON_RETAINABLE

Fields inherited from interface org.eclipse.jetty.io.RetainableByteBuffer

EMPTY

Constructor Summary

Constructors

Constructor	Description
Wrapper(RetainableByteBuffer wrapped)

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.
boolean	appendTo(ByteBuffer buffer)	Appends and consumes the contents of this buffer to the passed buffer, limited by the capacity of the target buffer.
boolean	appendTo(RetainableByteBuffer buffer)	Appends and consumes the contents of this buffer to the passed buffer, limited by the capacity of the target buffer.
RetainableByteBuffer.Mutable	asMutable()	Access this buffer via the RetainableByteBuffer.Mutable API.
int	capacity()
void	clear()
RetainableByteBuffer	copy()	Creates a deep copy of this RetainableByteBuffer that is entirely independent
int	get(byte[] bytes, int offset, int length)	Consumes and copies the bytes from this RetainableByteBuffer to the given byte array.
byte	get(long index)	Returns a byte from this RetainableByteBuffer at a specific index
ByteBuffer	getByteBuffer()	Get the wrapped, not null, ByteBuffer.
RetainableByteBuffer	getWrapped()
boolean	hasRemaining()
boolean	isDirect()
boolean	isEmpty()
boolean	isFull()
boolean	isRetained()	Returns whether Retainable.retain() has been called at least one more time than Retainable.release().
RetainableByteBuffer.Mutable	put(byte b)	Put a byte 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.
void	putTo(ByteBuffer toInfillMode)	Consumes and puts the contents of this retainable byte buffer at the end of the given byte buffer.
int	remaining()
long	skip(long length)	Skips, advancing the ByteBuffer position, the given number of bytes.
RetainableByteBuffer	slice()	Get a slice of the buffer.
RetainableByteBuffer	slice(long length)	Get a partial slice of the buffer.
long	space()
String	toDetailString()
String	toString()
void	writeTo(Content.Sink sink, boolean last, Callback callback)	Asynchronously writes and consumes the contents of this retainable byte buffer into the given sink.

Methods inherited from class org.eclipse.jetty.io.Retainable.Wrapper

canRetain, getRetained, release, retain

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.io.Retainable

canRetain, getRetained, release, retain

Methods inherited from interface org.eclipse.jetty.io.RetainableByteBuffer

get, isMutable, limit, maxSize, size, take, take, takeByteArray, takeFrom, writeTo

Methods inherited from interface org.eclipse.jetty.io.RetainableByteBuffer.Mutable

put

Constructor Details

Wrapper

public Wrapper(RetainableByteBuffer wrapped)

Method Details

getWrapped

public RetainableByteBuffer getWrapped()

Overrides:

getWrapped in class Retainable.Wrapper

isRetained

public boolean isRetained()

Description copied from interface: Retainable

Returns whether Retainable.retain() has been called at least one more time than Retainable.release().

Specified by:

isRetained in interface Retainable

Overrides:

isRetained in class Retainable.Wrapper

Returns:

whether this buffer is retained

getByteBuffer

public ByteBuffer getByteBuffer()

Description copied from interface: RetainableByteBuffer

Get the wrapped, not null, ByteBuffer.

If the implementation contains multiple buffers, they are coalesced to a single buffer before being returned. If the content is too large for a single ByteBuffer, then the content should be access with RetainableByteBuffer.writeTo(Content.Sink, boolean).

Specified by:

getByteBuffer in interface RetainableByteBuffer

Returns:

the wrapped, not null, ByteBuffer

isDirect

public boolean isDirect()

Specified by:

isDirect in interface RetainableByteBuffer

Returns:

whether the ByteBuffer is direct

remaining

public int remaining()

Specified by:

remaining in interface RetainableByteBuffer

Returns:

the number of remaining bytes in the ByteBuffer

See Also:

• RetainableByteBuffer.size()

hasRemaining

public boolean hasRemaining()

Specified by:

hasRemaining in interface RetainableByteBuffer

Returns:

whether the ByteBuffer has remaining bytes

capacity

public int capacity()

Specified by:

capacity in interface RetainableByteBuffer

Returns:

the capacity

See Also:

• RetainableByteBuffer.maxSize()

clear

public void clear()

Specified by:

clear in interface RetainableByteBuffer

See Also:

• BufferUtil.clear(ByteBuffer)

toString

public String toString()

Overrides:

toString in class Retainable.Wrapper

appendTo

public boolean appendTo(ByteBuffer buffer)

Description copied from interface: RetainableByteBuffer

Appends and consumes the contents of this buffer to the passed buffer, limited by the capacity of the target buffer.

Specified by:

appendTo in interface RetainableByteBuffer

Parameters:

buffer - The buffer to append bytes to, whose limit will be updated.

Returns:

true if all bytes in this buffer are able to be appended.

See Also:

• RetainableByteBuffer.putTo(ByteBuffer)

appendTo

public boolean appendTo(RetainableByteBuffer buffer)

Description copied from interface: RetainableByteBuffer

Appends and consumes the contents of this buffer to the passed buffer, limited by the capacity of the target buffer.

Specified by:

appendTo in interface RetainableByteBuffer

Parameters:

buffer - The buffer to append bytes to, whose limit will be updated.

Returns:

true if all bytes in this buffer are able to be appended.

See Also:

• RetainableByteBuffer.putTo(ByteBuffer)

copy

public RetainableByteBuffer copy()

Description copied from interface: RetainableByteBuffer

Creates a deep copy of this RetainableByteBuffer that is entirely independent

Specified by:

copy in interface RetainableByteBuffer

Returns:

A copy of this RetainableByteBuffer

slice

public RetainableByteBuffer slice(long length)

Description copied from interface: RetainableByteBuffer

Get a partial slice of the buffer. This is equivalent to RetainableByteBuffer.slice().RetainableByteBuffer.limit(long), but may be implemented more efficiently.

Specified by:

slice in interface RetainableByteBuffer

Parameters:

length - The number of bytes to slice, which may beyond the limit and less than the capacity, in which case it will ensure some spare capacity in the slice.

Returns:

A sliced RetainableByteBuffer sharing the first length bytes of this buffers data and reference count, but with independent position. The buffer is retained by this call.

get

public byte get(long index)

Description copied from interface: RetainableByteBuffer

Returns a byte from this RetainableByteBuffer at a specific index

Specified by:

get in interface RetainableByteBuffer

Parameters:

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

Returns:

the byte

get

public int get(byte[] bytes,
 int offset,
 int length)

Description copied from interface: RetainableByteBuffer

Consumes and copies the bytes from this RetainableByteBuffer to the given byte array.

Specified by:

get in interface RetainableByteBuffer

Parameters:

bytes - the byte array to copy the bytes into

offset - the offset within the byte array

length - the maximum number of bytes to copy

Returns:

the number of bytes actually copied

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface RetainableByteBuffer

Returns:

whether the ByteBuffer has remaining bytes left for reading

putTo

public void putTo(ByteBuffer toInfillMode)
           throws BufferOverflowException

Description copied from interface: RetainableByteBuffer

Consumes and puts the contents of this retainable byte buffer at the end of the given byte buffer.

Specified by:

putTo in interface RetainableByteBuffer

Parameters:

toInfillMode - the destination buffer, whose position is updated.

Throws:

BufferOverflowException - – If there is insufficient space in this buffer for the remaining bytes in the source buffer

See Also:

• ByteBuffer.put(ByteBuffer)

skip

public long skip(long length)

Description copied from interface: RetainableByteBuffer

Skips, advancing the ByteBuffer position, the given number of bytes.

Specified by:

skip in interface RetainableByteBuffer

Parameters:

length - the maximum number of bytes to skip

Returns:

the number of bytes actually skipped

slice

public RetainableByteBuffer slice()

Description copied from interface: RetainableByteBuffer

Get a slice of the buffer.

Specified by:

slice in interface RetainableByteBuffer

Returns:

A sliced RetainableByteBuffer sharing this buffers data and reference count, but with independent position. The buffer is retained by this call.

See Also:

• RetainableByteBuffer.slice(long)

writeTo

public void writeTo(Content.Sink sink,
 boolean last,
 Callback callback)

Description copied from interface: RetainableByteBuffer

Asynchronously writes and consumes the contents of this retainable byte buffer into the given sink.

Specified by:

writeTo in interface RetainableByteBuffer

Parameters:

sink - the destination sink.

last - true if this is the last write.

callback - the callback to call upon the write completion.

See Also:

• Content.Sink.write(boolean, ByteBuffer, Callback)

asMutable

public RetainableByteBuffer.Mutable asMutable()

Description copied from interface: RetainableByteBuffer

Access this buffer via the RetainableByteBuffer.Mutable API. Note that the RetainableByteBuffer.Mutable API may be backed by an immutable ByteBuffer.

Specified by:

asMutable in interface RetainableByteBuffer

Returns:

An RetainableByteBuffer.Mutable representation of this buffer with same data and pointers.

See Also:

• RetainableByteBuffer.isMutable()

isFull

public boolean isFull()

Specified by:

isFull in interface RetainableByteBuffer

Returns:

true if no more bytes can be added, appended or put to this buffer, assuming it is mutable.

space

public long space()

Specified by:

space in interface RetainableByteBuffer

Returns:

the number of bytes that can be added, appended or put into this buffer, assuming it is mutable.

append

public boolean append(ByteBuffer bytes)
               throws ReadOnlyBufferException

Description copied from interface: RetainableByteBuffer.Mutable

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

Specified by:

append in interface RetainableByteBuffer.Mutable

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:

• RetainableByteBuffer.Mutable.add(ByteBuffer)

append

public boolean append(RetainableByteBuffer bytes)
               throws ReadOnlyBufferException

Description copied from interface: RetainableByteBuffer.Mutable

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 RetainableByteBuffer.Mutable.add(RetainableByteBuffer), implementations of this method must Retainable.retain() the passed buffer if they keep a reference to it.

Specified by:

append in interface RetainableByteBuffer.Mutable

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:

• RetainableByteBuffer.Mutable.add(RetainableByteBuffer)

add

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

Description copied from interface: RetainableByteBuffer.Mutable

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.

Specified by:

add in interface RetainableByteBuffer.Mutable

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:

• RetainableByteBuffer.Mutable.append(ByteBuffer)

add

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

Description copied from interface: RetainableByteBuffer.Mutable

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 RetainableByteBuffer.Mutable.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 RetainableByteBuffer.Mutable.append(RetainableByteBuffer) if they already have an obligation to release the buffer and wish to delegate that obligation to this buffer.

Specified by:

add in interface RetainableByteBuffer.Mutable

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

put

public RetainableByteBuffer.Mutable put(byte b)

Description copied from interface: RetainableByteBuffer.Mutable

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

Specified by:

put in interface RetainableByteBuffer.Mutable

Parameters:

b - the byte to put

Returns:

this buffer.

put

public RetainableByteBuffer.Mutable put(long index,
 byte b)

Description copied from interface: RetainableByteBuffer.Mutable

Put a byte to the buffer at a given index.

Specified by:

put in interface RetainableByteBuffer.Mutable

Parameters:

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

b - the byte to put

Returns:

this buffer.

putShort

public RetainableByteBuffer.Mutable putShort(short s)

Description copied from interface: RetainableByteBuffer.Mutable

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

Specified by:

putShort in interface RetainableByteBuffer.Mutable

Parameters:

s - the short to put

Returns:

this buffer.

putInt

public RetainableByteBuffer.Mutable putInt(int i)

Description copied from interface: RetainableByteBuffer.Mutable

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

Specified by:

putInt in interface RetainableByteBuffer.Mutable

Parameters:

i - the int to put

Returns:

this buffer.

putLong

public RetainableByteBuffer.Mutable putLong(long l)

Description copied from interface: RetainableByteBuffer.Mutable

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

Specified by:

putLong in interface RetainableByteBuffer.Mutable

Parameters:

l - the long to put

Returns:

this buffer.

put

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

Description copied from interface: RetainableByteBuffer.Mutable

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

Specified by:

put in interface RetainableByteBuffer.Mutable

Parameters:

bytes - the byte array to put

offset - the offset into the array

length - the length in bytes to put

Returns:

this buffer.

toDetailString

public String toDetailString()

Specified by:

toDetailString in interface RetainableByteBuffer

Returns:

A string showing the info and detail about this buffer, as well as a summary of the contents