Class MapBackedScopelet<M extends MapBackedScopelet<M>>

java.lang.Object

org.microbean.scopelet.Scopelet<M>

org.microbean.scopelet.MapBackedScopelet<M>

Type Parameters:

M - the MapBackedScopelet subclass extending this class

All Implemented Interfaces:

AutoCloseable, Constable, Aggregate, Factory<M>

Direct Known Subclasses:

SingletonScopelet

public abstract class MapBackedScopelet<M extends MapBackedScopelet<M>>
extends Scopelet<M>

A thread-safe, partial Scopelet implementation backed by ConcurrentMap machinery.

Author:

Laird Nelson

See Also:

• instance(Object, Factory, Creation)

Field Summary

Fields inherited from class org.microbean.scopelet.Scopelet

APPLICATION_ID, NONE_ID, SCOPE, SINGLETON_ID

Fields inherited from interface org.microbean.bean.Aggregate

EMPTY_ASSIGNMENTS, EMPTY_DEPENDENCIES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapBackedScopelet()	Creates a new MapBackedScopelet.

Method Summary

Modifier and Type	Method	Description
void	close()	Irrevocably closes this Scopelet, and, by doing so, notionally makes it irrevocably closed and inactive.
<I> I	instance(Object beanId, Factory<I> factory, Creation<I> creation)	Checks to see if this Scopelet is active and then returns a pre-existing or created-on-demand contextual instance suitable for the combination of identifier, Factory and Creation, or null
boolean	remove(Object id)	Checks to see if this Scopelet is active and then removes any contextual instance stored under the supplied id, returning true if and only if removal actually took place.

Methods inherited from class org.microbean.scopelet.Scopelet

active, closed, create, destroys, singleton

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.microbean.bean.Aggregate

assign, dependencies

Methods inherited from interface org.microbean.bean.Factory

describeConstable, destroy

Constructor Details

MapBackedScopelet

protected MapBackedScopelet()

Creates a new MapBackedScopelet.

See Also:

• Scopelet()

Method Details

close

public void close()

Description copied from class: Scopelet

Irrevocably closes this Scopelet, and, by doing so, notionally makes it irrevocably closed and inactive.

Overrides of this method must call super.close() as part of their implementation or undefined behavior may result.

Specified by:

close in interface AutoCloseable

Overrides:

close in class Scopelet<M extends MapBackedScopelet<M>>

See Also:

• Scopelet.closed()
• Scopelet.active()

instance

public <I> I instance(Object beanId,
 Factory<I> factory,
 Creation<I> creation)

Description copied from class: Scopelet

Checks to see if this Scopelet is active and then returns a pre-existing or created-on-demand contextual instance suitable for the combination of identifier, Factory and Creation, or null

Specified by:

instance in class Scopelet<M extends MapBackedScopelet<M>>

Type Parameters:

I - the type of contextual instance

Parameters:

beanId - an identifier that can identify a contextual instance; may be null

factory - a Factory; may be null

creation - a Creation, typically the one in effect that is causing this method to be invoked in the first place; may be null

Returns:

a contextual instance, possibly pre-existing, or possibly created just in time, or null

See Also:

• Creation

remove

public boolean remove(Object id)

Description copied from class: Scopelet

Checks to see if this Scopelet is active and then removes any contextual instance stored under the supplied id, returning true if and only if removal actually took place.

The default implementation of this method always returns false. Subclasses are encouraged to override it as appropriate.

Overrides:

remove in class Scopelet<M extends MapBackedScopelet<M>>

Parameters:

id - an identifier; may be null

Returns:

true if and only if removal actually occurred