RetainableByteBuffer (Jetty :: IO Utility 10.0.8 API)

java.lang.Object
- org.eclipse.jetty.io.RetainableByteBuffer

All Implemented Interfaces:

org.eclipse.jetty.util.Retainable
```
public class RetainableByteBuffer
extends java.lang.Object
implements org.eclipse.jetty.util.Retainable
```
A pooled ByteBuffer which maintains a reference count that is incremented with retain() and decremented with release(). The buffer is released to the pool when release() is called one more time than retain().

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
Calling release() on a out of pool and retained instance does not re-pool it while that re-pools it on a out of pool but not retained instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`capacity()`
`void`	`clear()`
`java.nio.ByteBuffer`	`getBuffer()`
`long`	`getLastUpdate()`
`boolean`	`hasRemaining()`
`boolean`	`isDirect()`
`boolean`	`isEmpty()`
`boolean`	`isRetained()`	Checks if `retain()` has been called at least one more time than `release()`.
`boolean`	`release()`	Decrements the retained counter of this buffer.
`int`	`remaining()`
`void`	`retain()`	Increments the retained counter of this buffer.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - capacity
```
public int capacity()
```
  - getBuffer
```
public java.nio.ByteBuffer getBuffer()
```
  - getLastUpdate
```
public long getLastUpdate()
```
  - isRetained
```
public boolean isRetained()
```
    Checks if retain() has been called at least one more time than release().
    
    Returns:
    
    true if this buffer is retained, false otherwise.
  - isDirect
```
public boolean isDirect()
```
  - retain
```
public void retain()
```
    Increments the retained counter of this buffer.
    
    Specified by:
    
    retain in interface org.eclipse.jetty.util.Retainable
  - release
```
public boolean release()
```
    Decrements the retained counter of this buffer.
    
    Returns:
    
    true if the buffer was re-pooled, false otherwise.
  - remaining
```
public int remaining()
```
  - hasRemaining
```
public boolean hasRemaining()
```
  - isEmpty
```
public boolean isEmpty()
```
  - clear
```
public void clear()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object