Class Instance<I>

java.lang.Object

org.microbean.scopelet.Instance<I>

Type Parameters:

I - the type of the instance

All Implemented Interfaces:

AutoCloseable, Supplier<I>

public final class Instance<I>
extends Object
implements AutoCloseable, Supplier<I>

An AutoCloseable pairing of a contextual instance that can be destroyed with a Instance.Destructor that can destroy it, an AutoCloseable that can release its dependent objects when needed, and a Request that caused it to be created.

Author:

Laird Nelson

See Also:

• Instance.Destructor
• Request

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Instance.Destructor<I>	An interface whose implementations can destroy contextual instances.

Constructor Summary

Constructors

Constructor	Description
Instance(I contextualInstance, Instance.Destructor<I> destructor, Request<I> creationRequest)	Creates a new Instance.

Method Summary

Modifier and Type	Method	Description
final void	close()
final boolean	closed()	Returns true if and only if this Instance has been closed.
final boolean	equals(Object other)
final I	get()	Returns the contextual instance this Instance holds, which may be null.
final int	hashCode()
final String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Instance

public Instance(I contextualInstance,
 Instance.Destructor<I> destructor,
 Request<I> creationRequest)

Creates a new Instance.

Parameters:

contextualInstance - a contextual instance that has just been created; may be null

destructor - a Instance.Destructor capable of (eventually) destroying the supplied contextualInstance; may be null

creationRequest - a Request that is the reason for this creation; may be null

Method Details

get

public final I get()

Returns the contextual instance this Instance holds, which may be null.

Specified by:

get in interface Supplier<I>

Returns:

the contextual instance this Instance holds, which may be null

close

public final void close()

Specified by:

close in interface AutoCloseable

closed

public final boolean closed()

Returns true if and only if this Instance has been closed.

Returns:

true if and only if this Instance has been closed

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object other)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object