net.kuujo.catalyst.util

Interface ReferenceCounted<T>

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

Buffer

All Known Implementing Classes:

AbstractBuffer, DirectBuffer, FileBuffer, HeapBuffer, MappedBuffer, NativeBuffer, ReadOnlyBuffer, SlicedBuffer, SwappedBuffer

public interface ReferenceCounted<T>
extends AutoCloseable

Reference counting interface.

Types that implement ReferenceCounted can be counted for references and thus used to clean up resources once a given instance of an object is no longer in use.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
T	acquire() Acquires a reference.
void	close() Defines an exception free close implementation.
int	references() Returns the number of open references.
boolean	release() Releases a reference.

Method Detail

acquire

T acquire()

Acquires a reference.

Returns:

The acquired reference.

release

boolean release()

Releases a reference.

Returns:

Indicates whether all references to the object have been released.

references

int references()

Returns the number of open references.

Returns:

The number of open references.

close

void close()

Defines an exception free close implementation.

Specified by:

close in interface AutoCloseable