Class ScopedInstances

java.lang.Object

org.microbean.scopelet.ScopedInstances

All Implemented Interfaces:

AutoCloseable, Instances

public class ScopedInstances
extends Object
implements Instances

An Instances implementation that is based on scopes.

Author:

Laird Nelson

See Also:

• supplier(Bean, Creation)
• Instances

Constructor Summary

Constructors

Constructor	Description
ScopedInstances(Domain domain)	Creates a new ScopedInstances.

Method Summary

Modifier and Type	Method	Description
protected Attributes	findScopeId(Collection<? extends Attributes> c)	Finds and returns the nearest scope identifier in the forest represented by the supplied Attributes.
protected boolean	isScopeId(Attributes a)	Returns true if and only if the supplied Attributes is deemed to be an identifier of a scope.
protected boolean	primordial(Collection<? extends Attributes> c)	Returns true if and only if the supplied Collection of Attributes is deemed to designate something as primordial.
boolean	proxiable(Id id)	Returns true if and only if the supplied Id is proxiable.
static final Reducible<AttributedType,Bean<?>>	reducible(Domain domain, Selectable<AttributedType,Bean<?>> selectable)	Returns a Reducible suitable for use with Scopelets.
static final Reducible<AttributedType,Bean<?>>	reducible(Domain domain, Selectable<AttributedType,Bean<?>> selectable, Reducer<AttributedType,Bean<?>> reducer)	Returns a Reducible suitable for use with Scopelets.
static final Reducible<AttributedType,Bean<?>>	reducible(Domain domain, Selectable<AttributedType,Bean<?>> selectable, Reducer<AttributedType,Bean<?>> reducer, BiFunction<? super List<? extends Bean<?>>,? super AttributedType,? extends Bean<?>> failureHandler)	Returns a Reducible suitable for use with Scopelets.
final <I> Supplier<? extends I>	supplier(Bean<I> bean, Creation<I> request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.microbean.reference.Instances

close

Constructor Details

ScopedInstances

public ScopedInstances(Domain domain)

Creates a new ScopedInstances.

Parameters:

domain - a Domain; must not be null

Throws:

NullPointerException - if domain is null

Method Details

findScopeId

protected Attributes findScopeId(Collection<? extends Attributes> c)

Finds and returns the nearest scope identifier in the forest represented by the supplied Attributes.

Parameters:

c - a Collection of Attributes; must not be null

Returns:

the nearest scope identifier in the forest represented by the supplied Attributes, or null

Throws:

NullPointerException - if c is null

isScopeId

protected boolean isScopeId(Attributes a)

Returns true if and only if the supplied Attributes is deemed to be an identifier of a scope.

Parameters:

a - an Attributes; must not be null

Returns:

true if and only if the supplied Attributes is deemed to be an identifier of a scope

Throws:

NullPointerException - if a is null

primordial

protected boolean primordial(Collection<? extends Attributes> c)

Returns true if and only if the supplied Collection of Attributes is deemed to designate something as primordial.

The default implementation of this method returns true if and only if the supplied Collection contains the primordial qualifier.

Parameters:

c - a Collection; must not be null

Returns:

true if and only if the supplied Collection of Attributes is deemed to designate something as primordial

Throws:

NullPointerException - if c is null

proxiable

public boolean proxiable(Id id)

Returns true if and only if the supplied Id is proxiable.

Specified by:

proxiable in interface Instances

Parameters:

id - an Id; must not be null

Returns:

true if and only if the supplied Id is proxiable

Throws:

NullPointerException - if id is null

supplier

public final <I> Supplier<? extends I> supplier(Bean<I> bean,
 Creation<I> request)

Specified by:

supplier in interface Instances

reducible

public static final Reducible<AttributedType,Bean<?>> reducible(Domain domain,
 Selectable<AttributedType,Bean<?>> selectable)

Returns a Reducible suitable for use with Scopelets.

Parameters:

domain - a Domain (that is normally shared among other cooperating components); must not be null

selectable - a Selectable; must not be null

Returns:

a non-null Reducible

Throws:

NullPointerException - if any argument is null

See Also:

• reducible(Domain, Selectable, Reducer)
• RankedReducer.of()

reducible

public static final Reducible<AttributedType,Bean<?>> reducible(Domain domain,
 Selectable<AttributedType,Bean<?>> selectable,
 Reducer<AttributedType,Bean<?>> reducer)

Returns a Reducible suitable for use with Scopelets.

Parameters:

domain - a Domain (that is normally shared among other cooperating components); must not be null

selectable - a Selectable; must not be null

reducer - a Reducer; must not be null

Returns:

a non-null Reducible

Throws:

NullPointerException - if any argument is null

See Also:

• reducible(Domain, Selectable, Reducer, BiFunction)
• Reducer.fail(List, Object)

reducible

public static final Reducible<AttributedType,Bean<?>> reducible(Domain domain,
 Selectable<AttributedType,Bean<?>> selectable,
 Reducer<AttributedType,Bean<?>> reducer,
 BiFunction<? super List<? extends Bean<?>>,? super AttributedType,? extends Bean<?>> failureHandler)

Returns a Reducible suitable for use with Scopelets.

Parameters:

domain - a Domain (that is normally shared among other cooperating components); must not be null

selectable - a Selectable; must not be null

reducer - a Reducer; must not be null

failureHandler - a BiFunction serving as the supplied Reducer's failure handler; must not be null

Returns:

a non-null Reducible

Throws:

NullPointerException - if any argument is null