net.openhft.chronicle.core.scoped

Interface ScopedResource<T>

Type Parameters:

T - the type of the resource contained

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

StrongReferenceScopedResource, WeakReferenceScopedResource

public interface ScopedResource<T>
extends Closeable

A short-lived handle to a shared resource.

Instances are obtained from a ScopedResourcePool such as ScopedThreadLocal and are expected to be used with the try-with-resources idiom. The underlying resource is returned to the pool when close() completes. Clients must not retain a reference to the resource after the scope ends.

See Also:

ScopedResourcePool, ScopedThreadLocal

Method Summary

Modifier and Type	Method and Description
void	close() Signifies the end of the scope and returns the resource to the pool for use by other acquirers.
T	get() Get the contained resource

Method Detail

get

T get()

Get the contained resource

Returns:

The resource

close

void close()

Signifies the end of the scope and returns the resource to the pool for use by other acquirers.

This method is idempotent; additional invocations have no effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable