io.atomix.catalyst.util.reference

Class ReferencePool<T extends ReferenceCounted<?>>

java.lang.Object

io.atomix.catalyst.util.reference.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 and Description
ReferencePool(ReferenceFactory<T> factory)

Method Summary

Modifier and Type	Method and Description
T	acquire() Acquires a reference.
void	close()
void	release(T reference) Releases the given reference.

Methods inherited from class java.lang.Object

equals, 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