Core :: IO 12.0.6 · org.eclipse.jetty.io.RetainableByteBuffer

A pooled ByteBuffer which maintains a reference count that is incremented with retain() and decremented with release().

The ByteBuffer is released to a ByteBufferPool when release() is called one more time than retain(); in such case, the call to release() returns true.

A RetainableByteBuffer can either be:

in pool; in this case isRetained() returns false and calling release() throws IllegalStateException
out of pool but not retained; in this case isRetained() returns false and calling release() returns true
out of pool and retained; in this case isRetained() returns true and calling release() returns false

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	RetainableByteBuffer.Wrapper A wrapper for `RetainableByteBuffer` instances

Field Summary

Modifier and Type	Field and Description
public static final RetainableByteBuffer	EMPTY A Zero-capacity, non-retainable `RetainableByteBuffer`.

Method Summary

Modifier and Type	Method and Description
public default int	Returns: the `ByteBuffer` capacity capacity()
public default void	clear()
public ByteBuffer	Returns: the wrapped, not `null`, `ByteBuffer` getByteBuffer() Get the wrapped, not `null`, `ByteBuffer`.
public default boolean	Returns: whether the `ByteBuffer` has remaining bytes hasRemaining()
public default boolean	Returns: whether the `ByteBuffer` is direct isDirect()
public boolean	Returns: whether this instance is retained isRetained()
public default int	Returns: the number of remaining bytes in the `ByteBuffer` remaining()
public static RetainableByteBuffer	Returns: a non-retainable `RetainableByteBuffer` wrap(ByteBuffer the `ByteBuffer` to wrap byteBuffer) Returns a non-retainable `RetainableByteBuffer` that wraps the given `ByteBuffer`.
public static RetainableByteBuffer	Returns: a `RetainableByteBuffer` wrap(ByteBuffer the `ByteBuffer` to wrap byteBuffer, Retainable the associated `Retainable`. retainable) Returns a `RetainableByteBuffer` that wraps the given `ByteBuffer` and `Retainable`.

Inherited from org.eclipse.jetty.io.Retainable:: canRetain release retain

Field Detail

EMPTY	back to summary
public static final RetainableByteBuffer EMPTY A Zero-capacity, non-retainable `RetainableByteBuffer`.

Method Detail

capacity	back to summary
public default int capacity() Returns:int the `ByteBuffer` capacity

clear	back to summary
public default void clear() See Also `BufferUtil#clear(ByteBuffer)`

getByteBuffer back to summary

getByteBuffer	back to summary
public ByteBuffer getByteBuffer() Get the wrapped, not `null`, `ByteBuffer`. Returns:ByteBuffer the wrapped, not `null`, `ByteBuffer`

public ByteBuffer getByteBuffer()

Get the wrapped, not null, ByteBuffer.

Returns:ByteBuffer: the wrapped, not null, ByteBuffer

hasRemaining	back to summary
public default boolean hasRemaining() Returns:boolean whether the `ByteBuffer` has remaining bytes

isDirect	back to summary
public default boolean isDirect() Returns:boolean whether the `ByteBuffer` is direct

isRetained	back to summary
public boolean isRetained() Returns:boolean whether this instance is retained See Also `ReferenceCounter#isRetained()`

remaining	back to summary
public default int remaining() Returns:int the number of remaining bytes in the `ByteBuffer`

wrap back to summary

wrap	back to summary
public static RetainableByteBuffer wrap(ByteBuffer byteBuffer) Returns a non-retainable `RetainableByteBuffer` that wraps the given `ByteBuffer`. Use this method to wrap user-provided `ByteBuffer`s, or `ByteBuffer`s that hold constant bytes, to make them look like `RetainableByteBuffer`s. The returned `RetainableByteBuffer` `canRetain()` method always returns `false`. `RetainableByteBuffer`s returned by this method are not suitable to be wrapped in other `Retainable` implementations that may delegate calls to `retain()`. Parameters byteBuffer:ByteBuffer the `ByteBuffer` to wrap Returns:RetainableByteBuffer a non-retainable `RetainableByteBuffer` See Also `ByteBufferPool.NonPooling`

public static RetainableByteBuffer wrap(ByteBuffer byteBuffer)

Returns a non-retainable RetainableByteBuffer that wraps the given ByteBuffer.

Use this method to wrap user-provided ByteBuffers, or ByteBuffers that hold constant bytes, to make them look like RetainableByteBuffers.

The returned RetainableByteBuffer canRetain() method always returns false.

RetainableByteBuffers returned by this method are not suitable to be wrapped in other Retainable implementations that may delegate calls to retain().

Parameters

byteBuffer:ByteBuffer: the ByteBuffer to wrap

Returns:RetainableByteBuffer

a non-retainable RetainableByteBuffer

See Also

ByteBufferPool.NonPooling

wrap back to summary

wrap	back to summary
public static RetainableByteBuffer wrap(ByteBuffer byteBuffer, Retainable retainable) Returns a `RetainableByteBuffer` that wraps the given `ByteBuffer` and `Retainable`. Parameters byteBuffer:ByteBuffer the `ByteBuffer` to wrap retainable:Retainable the associated `Retainable`. Returns:RetainableByteBuffer a `RetainableByteBuffer` See Also `ByteBufferPool.NonPooling`

public static RetainableByteBuffer wrap(ByteBuffer byteBuffer, Retainable retainable)

Returns a RetainableByteBuffer that wraps the given ByteBuffer and Retainable.

Parameters

byteBuffer:ByteBuffer: the ByteBuffer to wrap
retainable:Retainable: the associated Retainable.

Returns:RetainableByteBuffer

a RetainableByteBuffer

See Also

ByteBufferPool.NonPooling

Access	Constructor and Description
public	Wrapper(RetainableByteBuffer wrapped)

Access

Constructor and Description

public

Wrapper(RetainableByteBuffer wrapped)

Modifier and Type	Method and Description
public int	capacity() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.capacity.
public void	clear() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.clear.
public ByteBuffer	getByteBuffer() Implements org.eclipse.jetty.io.RetainableByteBuffer.getByteBuffer. Get the wrapped, not `null`, `ByteBuffer`.
public RetainableByteBuffer	getWrapped() Overrides org.eclipse.jetty.io.Retainable.Wrapper.getWrapped.
public boolean	hasRemaining() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.hasRemaining.
public boolean	isDirect() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.isDirect.
public boolean	isRetained() Implements org.eclipse.jetty.io.RetainableByteBuffer.isRetained.
public int	remaining() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.remaining.

Modifier and Type

Method and Description

public int

capacity()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.capacity.

public void

clear()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.clear.

public ByteBuffer

getByteBuffer()

Implements org.eclipse.jetty.io.RetainableByteBuffer.getByteBuffer.

Get the wrapped, not null, ByteBuffer.

public RetainableByteBuffer

getWrapped()

Overrides org.eclipse.jetty.io.Retainable.Wrapper.getWrapped.

public boolean

hasRemaining()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.hasRemaining.

public boolean

isDirect()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.isDirect.

public boolean

isRetained()

Implements org.eclipse.jetty.io.RetainableByteBuffer.isRetained.

public int

remaining()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.remaining.

Wrapper	back to summary
public Wrapper(RetainableByteBuffer wrapped)

Wrapper

back to summary

public Wrapper(RetainableByteBuffer wrapped)

capacity	back to summary
public int capacity() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.capacity. Returns:int Doc from org.eclipse.jetty.io.RetainableByteBuffer.capacity. the `ByteBuffer` capacity Annotations @Override

capacity

back to summary

public int capacity()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.capacity.

Returns:int

Doc from org.eclipse.jetty.io.RetainableByteBuffer.capacity.

the ByteBuffer capacity

Annotations

@Override

clear	back to summary
public void clear() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.clear. Annotations @Override

clear

back to summary

public void clear()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.clear.

Annotations

@Override

getByteBuffer	back to summary
public ByteBuffer getByteBuffer() Implements org.eclipse.jetty.io.RetainableByteBuffer.getByteBuffer. Doc from org.eclipse.jetty.io.RetainableByteBuffer.getByteBuffer. Get the wrapped, not `null`, `ByteBuffer`. Returns:ByteBuffer the wrapped, not `null`, `ByteBuffer` Annotations @Override

getByteBuffer

back to summary

public ByteBuffer getByteBuffer()

Implements org.eclipse.jetty.io.RetainableByteBuffer.getByteBuffer.

Doc from org.eclipse.jetty.io.RetainableByteBuffer.getByteBuffer.

Get the wrapped, not null, ByteBuffer.

Returns:ByteBuffer

the wrapped, not null, ByteBuffer

Annotations

@Override

getWrapped	back to summary
public RetainableByteBuffer getWrapped() Overrides org.eclipse.jetty.io.Retainable.Wrapper.getWrapped.

getWrapped

back to summary

public RetainableByteBuffer getWrapped()

Overrides org.eclipse.jetty.io.Retainable.Wrapper.getWrapped.

hasRemaining	back to summary
public boolean hasRemaining() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.hasRemaining. Returns:boolean Doc from org.eclipse.jetty.io.RetainableByteBuffer.hasRemaining. whether the `ByteBuffer` has remaining bytes Annotations @Override

hasRemaining

back to summary

public boolean hasRemaining()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.hasRemaining.

Returns:boolean

Doc from org.eclipse.jetty.io.RetainableByteBuffer.hasRemaining.

whether the ByteBuffer has remaining bytes

Annotations

@Override

isDirect	back to summary
public boolean isDirect() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.isDirect. Returns:boolean Doc from org.eclipse.jetty.io.RetainableByteBuffer.isDirect. whether the `ByteBuffer` is direct Annotations @Override

isDirect

back to summary

public boolean isDirect()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.isDirect.

Returns:boolean

Doc from org.eclipse.jetty.io.RetainableByteBuffer.isDirect.

whether the ByteBuffer is direct

Annotations

@Override

isRetained	back to summary
public boolean isRetained() Implements org.eclipse.jetty.io.RetainableByteBuffer.isRetained. Returns:boolean Doc from org.eclipse.jetty.io.RetainableByteBuffer.isRetained. whether this instance is retained Annotations @Override

isRetained

back to summary

public boolean isRetained()

Implements org.eclipse.jetty.io.RetainableByteBuffer.isRetained.

Returns:boolean

Doc from org.eclipse.jetty.io.RetainableByteBuffer.isRetained.

whether this instance is retained

Annotations

@Override

remaining	back to summary
public int remaining() Overrides default org.eclipse.jetty.io.RetainableByteBuffer.remaining. Returns:int Doc from org.eclipse.jetty.io.RetainableByteBuffer.remaining. the number of remaining bytes in the `ByteBuffer` Annotations @Override

remaining

back to summary

public int remaining()

Overrides default org.eclipse.jetty.io.RetainableByteBuffer.remaining.

Returns:int

Doc from org.eclipse.jetty.io.RetainableByteBuffer.remaining.

the number of remaining bytes in the ByteBuffer

Annotations