Class Qualifiers

java.lang.Object

org.microbean.assign.Qualifiers

All Implemented Interfaces:

Constable

public class Qualifiers
extends Object
implements Constable

A utility class for working with qualifiers.

This class is currently not used by other classes in this package. It may be useful in a variety of dependency injection systems.

Author:

Laird Nelson

Constructor Summary

Constructors

Constructor	Description
Qualifiers(AnnotationMirror metaQualifier)	Creates a new Qualifiers.
Qualifiers(AnnotationMirror metaQualifier, Predicate<? super ExecutableElement> annotationElementInclusionPredicate)	Creates a new Qualifiers.
Qualifiers(Domain domain)	Creates a new Qualifiers.
Qualifiers(Domain domain, AnnotationMirror metaQualifier, Predicate<? super ExecutableElement> annotationElementInclusionPredicate)	Creates a new Qualifiers.

Method Summary

Modifier and Type	Method	Description
final boolean	contains(Collection<? extends AnnotationMirror> c, AnnotationMirror a)	Returns true if and only if the supplied Collection of AnnotationMirrors contains an AnnotationMirror that is the same as the supplied AnnotationMirror.
final boolean	containsAll(Collection<? extends AnnotationMirror> c0, Collection<? extends AnnotationMirror> c1)	Returns true if and only if c0 contains all the same AnnotationMirrors as are found in c1,
Optional<? extends ConstantDesc>	describeConstable()	Returns a non-null, determinate Optional housing a ConstantDesc describing this Qualifiers, or an empty Optional if it cannot be described.
final AnnotationMirror	metaQualifier()	Returns a non-null, determinate AnnotationMirror that can be used to designate (meta-annotate) other annotations as qualifiers.
final boolean	metaQualifier(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror is the same annotation as the supplied AnnotationMirror.
final List<AnnotationMirror>	metaQualifiers()	Returns a non-null, determinate, immutable List whose sole element is the meta-qualifier annotation.
final boolean	qualifier(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-qualifier.
List<AnnotationMirror>	qualifiers(Collection<? extends AnnotationMirror> as)	Returns a non-null, determinate, immutable List of AnnotationMirror instances drawn from the supplied Collection that were deemed to be qualifiers.
final boolean	sameAnnotation(AnnotationMirror am0, AnnotationMirror am1)	Determines whether the two AnnotationMirrors represent the same (underlying, otherwise opaque) annotation.

Methods inherited from class Object

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

Constructor Details

Qualifiers

public Qualifiers(Domain domain)

Creates a new Qualifiers.

Parameters:

domain - a non-null Domain

Throws:

NullPointerException - if domain is null

See Also:

• Qualifiers(Domain, AnnotationMirror, Predicate)

Qualifiers

public Qualifiers(AnnotationMirror metaQualifier)

Creates a new Qualifiers.

Parameters:

metaQualifier - a non-null AnnotationMirror to serve as the meta-qualifier

Throws:

NullPointerException - if metaQualifier is null

See Also:

• Qualifiers(Domain, AnnotationMirror, Predicate)

Qualifiers

public Qualifiers(AnnotationMirror metaQualifier,
 Predicate<? super ExecutableElement> annotationElementInclusionPredicate)

Creates a new Qualifiers.

Parameters:

metaQualifier - a non-null AnnotationMirror to serve as the meta-qualifier

annotationElementInclusionPredicate - a Predicate that returns true if a given ExecutableElement, representing an annotation element, is to be included in the computation; may be null in which case it is as if e -> true were supplied instead

Throws:

NullPointerException - if metaQualifier is null

See Also:

• Qualifiers(Domain, AnnotationMirror, Predicate)

Qualifiers

public Qualifiers(Domain domain,
 AnnotationMirror metaQualifier,
 Predicate<? super ExecutableElement> annotationElementInclusionPredicate)

Creates a new Qualifiers.

Parameters:

domain - a Domain; if null, then metaQualifier must not be null

metaQualifier - an AnnotationMirror to serve as the meta-qualifier; may (commonly) be null in which case a synthetic meta-qualifier will be used instead; must not be null if domain is null

annotationElementInclusionPredicate - a Predicate that returns true if a given ExecutableElement, representing an annotation element, is to be included in the computation; may be null in which case it is as if e -> true were supplied instead

Throws:

NullPointerException - if domain is null in certain situations

Method Details

contains

public final boolean contains(Collection<? extends AnnotationMirror> c,
 AnnotationMirror a)

Returns true if and only if the supplied Collection of AnnotationMirrors contains an AnnotationMirror that is the same as the supplied AnnotationMirror.

Parameters:

c - a non-null Collection of AnnotationMirrors

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied Collection of AnnotationMirrors contains an AnnotationMirror that is the same as the supplied AnnotationMirror

Throws:

NullPointerException - if c or a is null

See Also:

• AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotationMirror, Predicate)
• AnnotationMirrors.contains(Collection, AnnotationMirror, Predicate)
• Qualifiers(Domain, AnnotationMirror, Predicate)

containsAll

public final boolean containsAll(Collection<? extends AnnotationMirror> c0,
 Collection<? extends AnnotationMirror> c1)

Returns true if and only if c0 contains all the same AnnotationMirrors as are found in c1,

Parameters:

c0 - a non-null Collection of AnnotationMirrors

c1 - a non-null Collection of AnnotationMirrors

Returns:

true if and only if c0 contains all the same AnnotationMirrors as are found in c1

Throws:

NullPointerException - if either c0 or c1 is null

See Also:

• AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotationMirror, Predicate)
• AnnotationMirrors.containsAll(Collection, Collection, Predicate)
• Qualifiers(Domain, AnnotationMirror, Predicate)

describeConstable

public Optional<? extends ConstantDesc> describeConstable()

Returns a non-null, determinate Optional housing a ConstantDesc describing this Qualifiers, or an empty Optional if it cannot be described.

Specified by:

describeConstable in interface Constable

Returns:

a non-null, determinate Optional housing a ConstantDesc describing this Qualifiers, or an empty Optional if it cannot be described

metaQualifier

public final AnnotationMirror metaQualifier()

Returns a non-null, determinate AnnotationMirror that can be used to designate (meta-annotate) other annotations as qualifiers.

Returns:

a non-null, determinate AnnotationMirror that can be used to designate (meta-annotate) other annotations as qualifiers

metaQualifier

public final boolean metaQualifier(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror is the same annotation as the supplied AnnotationMirror.

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if if and only if the supplied AnnotationMirror is the same annotation as the supplied AnnotationMirror

Throws:

NullPointerException - if a is null

See Also:

• sameAnnotation(AnnotationMirror, AnnotationMirror)

metaQualifiers

public final List<AnnotationMirror> metaQualifiers()

Returns a non-null, determinate, immutable List whose sole element is the meta-qualifier annotation.

Returns:

a non-null, determinate, immutable List whose sole element is the meta-qualifier annotation

qualifier

public final boolean qualifier(AnnotationMirror a)

Returns true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-qualifier.

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied AnnotationMirror has an annotation type declared by a TypeElement that is annotated with at least one annotation deemed to be the meta-qualifier

Throws:

NullPointerException - if a is null

qualifiers

public List<AnnotationMirror> qualifiers(Collection<? extends AnnotationMirror> as)

Returns a non-null, determinate, immutable List of AnnotationMirror instances drawn from the supplied Collection that were deemed to be qualifiers.

Parameters:

as - a non-null Collection of AnnotationMirrors

Returns:

a non-null, determinate, immutable List of AnnotationMirror instances drawn from the supplied Collection that were deemed to be qualifiers

Throws:

NullPointerException - if as is null

See Also:

• qualifier(AnnotationMirror)

sameAnnotation

public final boolean sameAnnotation(AnnotationMirror am0,
 AnnotationMirror am1)

Determines whether the two AnnotationMirrors represent the same (underlying, otherwise opaque) annotation.

Parameters:

am0 - an AnnotationMirror; may be null

am1 - an AnnotationMirror; may be null

Returns:

true if the supplied AnnotationMirrors represent the same (underlying, otherwise opaque) annotation; false otherwise

See Also:

• AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotatonMirror, Predicate)
• Qualifiers(Domain, AnnotationMirror, Predicate)