Package org.eclipse.jetty.io

Class AbstractRetainableByteBuffer

java.lang.Object

org.eclipse.jetty.io.AbstractRetainableByteBuffer

All Implemented Interfaces:

Retainable, RetainableByteBuffer

public abstract class AbstractRetainableByteBuffer
extends Object
implements RetainableByteBuffer

Abstract implementation of RetainableByteBuffer with reference counting.

Nested Class Summary

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

Retainable.ReferenceCounter

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

RetainableByteBuffer.Wrapper

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
AbstractRetainableByteBuffer(ByteBuffer byteBuffer)

Method Summary

Modifier and Type	Method	Description
protected void	acquire()
boolean	canRetain()	Returns whether this resource is referenced counted by calls to Retainable.retain() and Retainable.release().
ByteBuffer	getByteBuffer()	Get the wrapped, not null, ByteBuffer.
boolean	isRetained()
boolean	release()	Releases this resource, potentially decrementing a reference count (if any).
void	retain()	Retains this resource, potentially incrementing a reference count if there are resources that will be released.
String	toString()

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.RetainableByteBuffer

capacity, clear, hasRemaining, isDirect, remaining

Constructor Details

AbstractRetainableByteBuffer

public AbstractRetainableByteBuffer(ByteBuffer byteBuffer)

Method Details

acquire

protected void acquire()

See Also:

• Retainable.ReferenceCounter.acquire()

canRetain

public boolean canRetain()

Description copied from interface: Retainable

Returns whether this resource is referenced counted by calls to Retainable.retain() and Retainable.release().

Implementations may decide that special resources are not not referenced counted (for example, static constants) so calling Retainable.retain() is a no-operation, and calling Retainable.release() on those special resources is a no-operation that always returns true.

Specified by:

canRetain in interface Retainable

Returns:

true if calls to Retainable.retain() are reference counted.

retain

public void retain()

Description copied from interface: Retainable

Retains this resource, potentially incrementing a reference count if there are resources that will be released.

Specified by:

retain in interface Retainable

release

public boolean release()

Description copied from interface: Retainable

Releases this resource, potentially decrementing a reference count (if any).

Specified by:

release in interface Retainable

Returns:

true when the reference count goes to zero or if there was no reference count, false otherwise.

isRetained

public boolean isRetained()

Specified by:

isRetained in interface RetainableByteBuffer

Returns:

whether this instance is retained

See Also:

• Retainable.ReferenceCounter.isRetained()

getByteBuffer

public ByteBuffer getByteBuffer()

Description copied from interface: RetainableByteBuffer

Get the wrapped, not null, ByteBuffer.

Specified by:

getByteBuffer in interface RetainableByteBuffer

Returns:

the wrapped, not null, ByteBuffer

toString

public String toString()

Overrides:

toString in class Object