Package io.github.classgraph.utils

Class Recycler<T extends AutoCloseable,E extends Exception>

java.lang.Object

io.github.classgraph.utils.Recycler<T,E>

Type Parameters:

T - The type to recycle.

E - An exception type that can be thrown while acquiring an instance of the type to recycle.

All Implemented Interfaces:

AutoCloseable

public abstract class Recycler<T extends AutoCloseable,E extends Exception>
extends Object
implements AutoCloseable

Recycle instances of type T. The method T#close() is called when this class' own close() method is called. Use RuntimeException for type E if the newInstance() method does not throw an exception. Example usage: // Autoclose the Recycler when last instance has been released try (Recycler<ZipFile, IOException> recycler = new Recycler<>() { @Override public ZipFile newInstance() throws IOException { return new ZipFile(zipFilePath); } }) { // Repeat the following as many times as needed, on as many threads as needed try { ZipFile zipFile = recycler.acquire(); try { // Read from zipFile -- don't put recycler.acquire() in this try block, otherwise the // finally block will try to release the zipfile even when recycler.acquire() failed // [...] } finally { recycler.release(zipFile); zipFile = null; } } catch (IOException e) { // May be thrown by recycler.acquire() } }

Constructor Summary

Constructors

Constructor	Description
Recycler()

Method Summary

Modifier and Type	Method	Description
T	acquire()	Acquire or allocate an instance.
void	close()	Call this only after all instances have been released.
abstract T	newInstance()	Create a new instance.
void	release(T instance)	Release/recycle an instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Recycler

public Recycler()

Method Detail

acquire

public T acquire()
          throws E extends Exception

Acquire or allocate an instance.

Returns:

The allocated instance.

Throws:

E - If an exception of type E was thrown during instantiation.

E extends Exception

release

public void release(T instance)

Release/recycle an instance.

Parameters:

instance - The instance to release.

close

public void close()

Call this only after all instances have been released.

Specified by:

close in interface AutoCloseable

newInstance

public abstract T newInstance()
                       throws E extends Exception

Create a new instance.

Returns:

The new instance.

Throws:

E - If an exception of type E was thrown during instantiation.

E extends Exception