Class Scopes

java.lang.Object

org.microbean.scopelet.Scopes

public class Scopes
extends Object

A utility class for working with scopes and their identifiers.

Author:

Laird Nelson

Constructor Summary

Constructors

Constructor	Description
Scopes(Qualifiers qualifiers)	Creates a new Scopes.

Method Summary

Modifier and Type	Method	Description
Attributes	findScope(Collection<? extends Attributes> c)	Returns the first Attributes that is present in the supplied Collection of Attributes, and their meta-attributes, for which an invocation of the scope(Attributes) method returns true, or null, if no such Attributes exists.
Attributes	none()	Returns a non-null, determinate Attributes representing the identifier for the none scope.
Map<String,Value<?>>	normal()	Returns a non-null, determinate, immutable Map of size 1 that can be used with a scope to designate it as a normal scope.
boolean	normal(Attributes a)	Returns true if the supplied Attributes has elements that might be used to indicate that it is a normal scope.
Map<String,Value<?>>	pseudo()	Returns a non-null, determinate, immutable Map of size 1 that can be used with a scope to designate it as a pseudo scope.
Attributes	scope()	Returns the non-null, determinate Attributes that can be used to designate other Attributes as a scope.
boolean	scope(Attributes a)	Returns true if and only if the supplied Attributes is a scope identifier.
Attributes	singleton()	Returns a non-null, determinate Attributes representing the identifier for the singleton pseudo-scope.

Methods inherited from class Object

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

Constructor Details

Scopes

public Scopes(Qualifiers qualifiers)

Creates a new Scopes.

Parameters:

qualifiers - a Qualifiers; must not be null

Throws:

NullPointerException - if qualifiers is null

Method Details

findScope

public Attributes findScope(Collection<? extends Attributes> c)

Returns the first Attributes that is present in the supplied Collection of Attributes, and their meta-attributes, for which an invocation of the scope(Attributes) method returns true, or null, if no such Attributes exists.

The search is conducted in a breadth-first manner.

Parameters:

c - a Collection of Attributes; must not be null

Returns:

the first Attributes that is present in the supplied Collection of Attributes, and their meta-attributes, for which an invocation of the scope(Attributes) method returns true, or null, if no such Attributes exists

Throws:

NullPointerException - if c is null

none

public Attributes none()

Returns a non-null, determinate Attributes representing the identifier for the none scope.

Returns:

a non-null, determinate Attributes representing the identifier for the none scope

normal

public Map<String,Value<?>> normal()

Returns a non-null, determinate, immutable Map of size 1 that can be used with a scope to designate it as a normal scope.

Returns:

a non-null, determinate, immutable Map of size 1 that can be used with a scope to designate it as a normal scope

normal

public boolean normal(Attributes a)

Returns true if the supplied Attributes has elements that might be used to indicate that it is a normal scope.

Parameters:

a - an Attributes; must not be null

Returns:

true if the supplied Attributes has elements that might be used to indicate that it is a normal scope

Throws:

NullPointerException - if a is null

See Also:

• scope(Attributes)
• normal()

pseudo

public Map<String,Value<?>> pseudo()

Returns a non-null, determinate, immutable Map of size 1 that can be used with a scope to designate it as a pseudo scope.

Returns:

a non-null, determinate, immutable Map of size 1 that can be used with a scope to designate it as a pseudo scope

scope

public Attributes scope()

Returns the non-null, determinate Attributes that can be used to designate other Attributes as a scope.

Returns:

the non-null, determinate Attributes that can be used to designate other Attributes as a scope

scope

public boolean scope(Attributes a)

Returns true if and only if the supplied Attributes is a scope identifier.

Parameters:

a - an Attributes; must not be null

Returns:

true if and only if the supplied Attributes is a scope identifier

Throws:

NullPointerException - if a is null

singleton

public Attributes singleton()

Returns a non-null, determinate Attributes representing the identifier for the singleton pseudo-scope.

Returns:

a non-null, determinate Attributes representing the identifier for the singleton pseudo-scope