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 aq, Qualifiers sq, AnnotationMirror metaNormalScope, AnnotationMirror metaPseudoScope, AnnotationMirror singletonScope, AnnotationMirror noneScope)	Creates a new Scopes.
Scopes(Domain d, Qualifiers aq, Qualifiers sq)	Creates a new Scopes.
Scopes(Domain d, Qualifiers aq, Qualifiers sq, AnnotationMirror metaNormalScope, AnnotationMirror metaPseudoScope, AnnotationMirror singletonScope, AnnotationMirror noneScope)	Creates a new Scopes.

Method Summary

Modifier and Type	Method	Description
AnnotationMirror	findNormalScope(Collection<? extends AnnotationMirror> c)	Returns the first AnnotationMirror that is present in the supplied Collection of AnnotationMirrors, and their meta-annotations, for which an invocation of the normalScope(AnnotationMirror) method returns true, or null, if no such AnnotationMirror exists.
AnnotationMirror	findScope(Collection<? extends AnnotationMirror> c)	Returns the first AnnotationMirror that is present in the supplied Collection of AnnotationMirrors, and their meta-annotations, for which an invocation of the scope(AnnotationMirror) method returns true, or null, if no such AnnotationMirror exists.
final AnnotationMirror	metaNormalScope()	Returns the non-null, determinate AnnotationMirror that can be used to designate other AnnotationMirrors as normal scopes.
final AnnotationMirror	metaPseudoScope()	Returns the non-null, determinate AnnotationMirror that can be used to designate other AnnotationMirrors as scopes.
final AnnotationMirror	noneScope()	Returns a non-null, determinate AnnotationMirror representing the identifier for the none scope.
boolean	normal(AnnotationMirror a)	Returns true if the supplied AnnotationMirror has elements that might be used to indicate that it is a normal scope.
boolean	normalScope(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror is a normal scope identifier.
boolean	pseudoScope(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror is a pseudo-scope identifier.
final boolean	scope(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror is a scope identifier (either a pseudo-scope identifier or a normal scope identifier.
final AnnotationMirror	singletonScope()	Returns a non-null, determinate AnnotationMirror 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(Domain d,
 Qualifiers aq,
 Qualifiers sq)

Creates a new Scopes.

Parameters:

d - a non-null Domain

aq - a non-null Qualifiers

sq - a non-null Qualifiers

Throws:

NullPointerException - if any argument is null

See Also:

• Scopes(Domain, org.microbean.assign.Qualifiers, Qualifiers, AnnotationMirror, AnnotationMirror, AnnotationMirror, AnnotationMirror)

Scopes

public Scopes(Qualifiers aq,
 Qualifiers sq,
 AnnotationMirror metaNormalScope,
 AnnotationMirror metaPseudoScope,
 AnnotationMirror singletonScope,
 AnnotationMirror noneScope)

Creates a new Scopes.

Parameters:

aq - a non-null Qualifiers

sq - a non-null Qualifiers

metaNormalScope - a non-null AnnotationMirror designating another AnnotationMirror as identifying a normal scope

metaPseudoScope - a non-null AnnotationMirror designating another AnnotationMirror as identifying a pseudo scope

singletonScope - a non-null AnnotationMirror identifying the singleton scope

noneScope - a non-null AnnotationMirror identifying the none scope

Throws:

NullPointerException - if any argument is null

See Also:

• Scopes(Domain, org.mcirobean.assign.Qualifiers, Qualifires, AnnotationMirror, AnnotationMirror, AnnotationMirror, AnnotationMirror)

Scopes

public Scopes(Domain d,
 Qualifiers aq,
 Qualifiers sq,
 AnnotationMirror metaNormalScope,
 AnnotationMirror metaPseudoScope,
 AnnotationMirror singletonScope,
 AnnotationMirror noneScope)

Creates a new Scopes.

Parameters:

d - a Domain; if null, then metaNormalScope, metaPseudoScope, singletonScope, and noneScope must be non-null

aq - a non-null Qualifiers

sq - a non-null Qualifiers

metaNormalScope - an AnnotationMirror designating another AnnotationMirror as identifying a normal scope; may be null in which case d must be non-null

metaPseudoScope - an AnnotationMirror designating another AnnotationMirror as identifying a pseudo scope; may be null in which case d must be non-null

singletonScope - an AnnotationMirror identifying the singleton scope; may be null in which case d must be non-null

noneScope - an AnnotationMirror identifying the none scope; may be null in which case d must be non-null

Throws:

NullPointerException - if aq or sq is null, or if d is null in certain situations

Method Details

findNormalScope

public AnnotationMirror findNormalScope(Collection<? extends AnnotationMirror> c)

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

The search is conducted in a breadth-first manner.

Parameters:

c - a Collection of AnnotationMirrors; must not be null

Returns:

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

Throws:

NullPointerException - if c is null

findScope

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

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

The search is conducted in a breadth-first manner.

Parameters:

c - a Collection of AnnotationMirrors; must not be null

Returns:

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

Throws:

NullPointerException - if c is null

noneScope

public final AnnotationMirror noneScope()

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

Returns:

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

normal

public boolean normal(AnnotationMirror a)

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

Parameters:

a - a non-null, determinate AnnotationMirror

Returns:

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

Throws:

NullPointerException - if a is null

See Also:

• scope(AnnotationMirror)

metaNormalScope

public final AnnotationMirror metaNormalScope()

Returns the non-null, determinate AnnotationMirror that can be used to designate other AnnotationMirrors as normal scopes.

Returns:

the non-null, determinate AnnotationMirror that can be used to designate other AnnotationMirrors as normal scopes

metaPseudoScope

public final AnnotationMirror metaPseudoScope()

Returns the non-null, determinate AnnotationMirror that can be used to designate other AnnotationMirrors as scopes.

Returns:

the non-null, determinate AnnotationMirror that can be used to designate other AnnotationMirrors as scopes

normalScope

public boolean normalScope(AnnotationMirror a)

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

Parameters:

a - an AnnotationMirror; must not be null

Returns:

true if and only if the supplied AnnotationMirror is a normal scope identifier

Throws:

NullPointerException - if a is null

pseudoScope

public boolean pseudoScope(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror is a pseudo-scope identifier.

Parameters:

a - an AnnotationMirror; must not be null

Returns:

true if and only if the supplied AnnotationMirror is a pseudo-scope identifier

Throws:

NullPointerException - if a is null

scope

public final boolean scope(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror is a scope identifier (either a pseudo-scope identifier or a normal scope identifier.

Parameters:

a - an AnnotationMirror; must not be null

Returns:

true if and only if the supplied AnnotationMirror is a scope identifier (either a pseudo-scope identifier or a normal scope identifier

Throws:

NullPointerException - if a is null

singletonScope

public final AnnotationMirror singletonScope()

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

Returns:

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