ReferencePool (Atomix Utilities 0.25.4 API)

java.lang.Object
- io.atomix.utils.concurrent.ReferencePool<T>

All Implemented Interfaces:: ReferenceManager<T>, AutoCloseable

public class ReferencePool<T extends ReferenceCounted<?>>
extends Object
implements ReferenceManager<T>, AutoCloseable

Pool of reference counted objects.

Author:: Jordan Halterman

Constructor Summary

Constructors
Constructor Description

ReferencePool(ReferenceFactory<T> factory)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`acquire()`	Acquires a reference.
`void`	`close()`
`void`	`release(T reference)`	Releases the given reference.

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

- Constructor Detail
  - ReferencePool
```
public ReferencePool(ReferenceFactory<T> factory)
```
- Method Detail
  - acquire
```
public T acquire()
```
    Acquires a reference.
    
    Returns:
    
    The acquired reference.
  - release
```
public void release(T reference)
```
    Description copied from interface: ReferenceManager
    
    Releases the given reference.
    This method should be called with a ReferenceCounted object that contains no additional references. This allows, for instance, pools to recycle dereferenced objects.
    
    Specified by:
    
    release in interface ReferenceManager<T extends ReferenceCounted<?>>
    
    Parameters:
    
    reference - The reference to release.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable