Class RetainableByteBuffer.EmptyRetainableByteBuffer

java.lang.Object

org.eclipse.jetty.io.RetainableByteBuffer.EmptyRetainableByteBuffer

All Implemented Interfaces:

Retainable, RetainableByteBuffer

Enclosing interface:

RetainableByteBuffer

public static class RetainableByteBuffer.EmptyRetainableByteBuffer
extends Object
implements RetainableByteBuffer

A RetainableByteBuffer that is empty and not retainable.

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

Constructor Summary

Constructors

Constructor	Description
EmptyRetainableByteBuffer()

Method Summary

Modifier and Type	Method	Description
void	clear()
RetainableByteBuffer	copy()	Creates a deep copy of this RetainableByteBuffer that is entirely independent
ByteBuffer	getByteBuffer()	Get the wrapped, not null, ByteBuffer.
boolean	isMutable()	Check if the underlying implementation is mutable.
RetainableByteBuffer	slice()	Get a slice of the buffer.
RetainableByteBuffer	slice(long length)	Get a partial slice of the buffer.
RetainableByteBuffer	take()	Take the contents of this buffer, leaving it clear.
byte[]	takeByteArray()	Take the contents of this buffer, leaving it clear and independent.
String	toDetailString()

Methods inherited from class Object

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

Methods inherited from interface Retainable

canRetain, getRetained, isRetained, release, retain

Methods inherited from interface RetainableByteBuffer

appendTo, appendTo, asMutable, capacity, get, get, get, hasRemaining, isDirect, isEmpty, isFull, limit, maxSize, putTo, remaining, size, skip, space, take, takeFrom, writeTo, writeTo

Constructor Details

EmptyRetainableByteBuffer

public EmptyRetainableByteBuffer()

Method Details

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

isMutable

public boolean isMutable()

Description copied from interface: RetainableByteBuffer

Check if the underlying implementation is mutable. Note that the immutable RetainableByteBuffer API may be backed by a mutable ByteBuffer or the RetainableByteBuffer.Mutable API may be backed by an immutable ByteBuffer.

Specified by:

isMutable in interface RetainableByteBuffer

Returns:

whether this buffers implementation is mutable

See Also:

• RetainableByteBuffer.asMutable()

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

clear

public void clear()

Specified by:

clear in interface RetainableByteBuffer

See Also:

• BufferUtil.clear(ByteBuffer)

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)

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.

take

public RetainableByteBuffer take()

Description copied from interface: RetainableByteBuffer

Take the contents of this buffer, leaving it clear.

Specified by:

take in interface RetainableByteBuffer

Returns:

A buffer with the contents of this buffer, avoiding copies if possible.

See Also:

• RetainableByteBuffer.take(long)
• RetainableByteBuffer.takeFrom(long)

takeByteArray

public byte[] takeByteArray()

Description copied from interface: RetainableByteBuffer

Take the contents of this buffer, leaving it clear and independent.

Specified by:

takeByteArray in interface RetainableByteBuffer

Returns:

A possibly newly allocated array with the contents of this buffer, avoiding copies if possible.

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