Class Qualifiers

java.lang.Object

org.microbean.bean.Qualifiers

All Implemented Interfaces:

Constable

public class Qualifiers
extends Object
implements Constable

A utility class for working with qualifiers.

Author:

Laird Nelson

See Also:

• Qualifiers

Constructor Summary

Constructors

Constructor	Description
Qualifiers(Qualifiers aq, AnnotationMirror anyQualifier, AnnotationMirror defaultQualifier)	Creates a new Qualifiers.
Qualifiers(Domain d, Qualifiers aq)	Creates a new Qualifiers.
Qualifiers(Domain d, Qualifiers aq, AnnotationMirror anyQualifier, AnnotationMirror defaultQualifier)	Creates a new Qualifiers.

Method Summary

Modifier and Type	Method	Description
final List<AnnotationMirror>	anyAndDefaultQualifiers()	Returns a non-null, determinate, immutable List housing only the any qualifier and default qualifier.
final AnnotationMirror	anyQualifier()	Returns the non-null, determinate AnnotationMirror representing the any qualifier.
final boolean	anyQualifier(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror is the same as the any qualifier.
final List<AnnotationMirror>	anyQualifiers()	Returns a non-null, determinate, immutable List housing only the any qualifier.
final AnnotationMirror	defaultQualifier()	Returns the non-null, determinate AnnotationMirror representing the default qualifier.
final boolean	defaultQualifier(AnnotationMirror a)	Returns true if and only if the supplied AnnotationMirror is the same as the default qualifier.
final List<AnnotationMirror>	defaultQualifiers()	Returns a non-null, determinate, immutable List housing only the default qualifier.
Optional<? extends ConstantDesc>	describeConstable()

Methods inherited from class Object

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

Constructor Details

Qualifiers

public Qualifiers(Domain d,
 Qualifiers aq)

Creates a new Qualifiers.

Parameters:

d - a non-null Domain

aq - a non-null Qualifiers

Throws:

NullPointerException - if aq is null

See Also:

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

Qualifiers

public Qualifiers(Qualifiers aq,
 AnnotationMirror anyQualifier,
 AnnotationMirror defaultQualifier)

Creates a new Qualifiers.

Parameters:

aq - a non-null Qualifiers

anyQualifier - a non-null AnnotationMirror representing the any qualifier

defaultQualifier - a non-null AnnotationMirror representing the default qualifier

Throws:

NullPointerException - if any argument is null

See Also:

• Qualifiers

Qualifiers

public Qualifiers(Domain d,
 Qualifiers aq,
 AnnotationMirror anyQualifier,
 AnnotationMirror defaultQualifier)

Creates a new Qualifiers.

Parameters:

d - a Domain; may be null if both anyQualifier and defaultQualifier are non-null

aq - a non-null Qualifiers

anyQualifier - a (possibly null) AnnotationMirror representing the any qualifier; if null, then d must be non-null

defaultQualifier - a (possibly null) AnnotationMirror representing the default qualifier; if null, then d must be non-null

Throws:

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

See Also:

• Qualifiers

Method Details

anyAndDefaultQualifiers

public final List<AnnotationMirror> anyAndDefaultQualifiers()

Returns a non-null, determinate, immutable List housing only the any qualifier and default qualifier.

Returns:

a non-null, determinate, immutable List housing only the any qualifier and default qualifier

anyQualifier

public final AnnotationMirror anyQualifier()

Returns the non-null, determinate AnnotationMirror representing the any qualifier.

Returns:

the non-null, determinate AnnotationMirror representing the any qualifier

anyQualifiers

public final List<AnnotationMirror> anyQualifiers()

Returns a non-null, determinate, immutable List housing only the any qualifier.

Returns:

a non-null, determinate, immutable List housing only the any qualifier

anyQualifier

public final boolean anyQualifier(AnnotationMirror a)

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

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied AnnotationMirror is the same as the any qualifier

Throws:

NullPointerException - if a is null

See Also:

• anyQualifier()
• Qualifiers.sameAnnotation(AnnotationMirror, AnnotationMirror)

defaultQualifier

public final AnnotationMirror defaultQualifier()

Returns the non-null, determinate AnnotationMirror representing the default qualifier.

Returns:

the non-null, determinate AnnotationMirror representing the default qualifier

defaultQualifiers

public final List<AnnotationMirror> defaultQualifiers()

Returns a non-null, determinate, immutable List housing only the default qualifier.

Returns:

a non-null, determinate, immutable List housing only the default qualifier

defaultQualifier

public final boolean defaultQualifier(AnnotationMirror a)

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

Parameters:

a - a non-null AnnotationMirror

Returns:

true if and only if the supplied AnnotationMirror is the same as the default qualifier

Throws:

NullPointerException - if a is null

See Also:

• defaultQualifier()
• Qualifiers.sameAnnotation(AnnotationMirror, AnnotationMirror)

describeConstable

public Optional<? extends ConstantDesc> describeConstable()

Specified by:

describeConstable in interface Constable