org.xnio

Interface Pooled<T>

Type Parameters:

T - the pooled resource type

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ImmediatePooled, PooledAdaptor

public interface Pooled<T>
extends AutoCloseable

A resource which is pooled.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
void	close() Delegates to free().
void	discard() Discard this resource.
void	free() Free this resource for immediate re-use.
T	getResource() Get the pooled resource.

Method Detail

discard

void discard()

Discard this resource. Any backing resources corresponding to this pooled resource will be rendered unavailable until the pooled resource has been garbage-collected.

free

void free()

Free this resource for immediate re-use. The resource must not be accessed again after calling this method; if it is possible that an instance is still in use, you must call discard() instead.

getResource

T getResource()
       throws IllegalStateException

Get the pooled resource.

Returns:

the pooled resource

Throws:

IllegalStateException - if the resource has been freed or discarded already

close

void close()

Delegates to free().

Specified by:

close in interface AutoCloseable