net.openhft.chronicle.core.scoped

Class WeakReferenceScopedResource<T>

java.lang.Object

net.openhft.chronicle.core.scoped.WeakReferenceScopedResource<T>

Type Parameters:

T - the type of the contained resource

All Implemented Interfaces:

Closeable, AutoCloseable, ScopedResource<T>

public class WeakReferenceScopedResource<T>
extends Object

A ScopedResource backed by a WeakReference. When the resource is acquired a strong reference is taken and released again on close(). This allows the object to be reclaimed between usages. In contrast StrongReferenceScopedResource retains a strong reference for the lifetime of the wrapper.

Constructor Summary

Constructors

Constructor and Description
WeakReferenceScopedResource(ScopedThreadLocal<T> scopedThreadLocal, Supplier<T> supplier)

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.
void	closeResource() Close the contained resource and clear any references.
T	get() Get the contained resource
long	getCreatedTimeNanos() The time this resource was created
@Nullable Class<?>	getType() Get the type of object contained, may return null

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WeakReferenceScopedResource

public WeakReferenceScopedResource(ScopedThreadLocal<T> scopedThreadLocal,
                                   Supplier<T> supplier)

Method Detail

get

public T get()

Description copied from interface: ScopedResource

Get the contained resource

Returns:

The resource

close

public void close()

Description copied from interface: ScopedResource

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 Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ScopedResource<T>

closeResource

public void closeResource()

Close the contained resource and clear any references.

Called when a resource is permanently discarded from the pool or when the thread-local stack is closed.

Implementations should release all state and must be idempotent.

getType

@Nullable
public @Nullable Class<?> getType()

Get the type of object contained, may return null

Returns:

the type of object contained, or null if it can't be determined

getCreatedTimeNanos

public long getCreatedTimeNanos()

The time this resource was created

Returns:

the System.nanoTime() of creation