Class Qualifiers

java.lang.Object

org.microbean.assign.Qualifiers

public final class Qualifiers
extends Object

A utility class for working with commonly-used qualifiers.

Author:

Laird Nelson

See Also:

• Attributes

Method Summary

Modifier and Type	Method	Description
static final List<Attributes>	anyAndDefaultQualifiers()	Returns an unmodifiable List consisting solely of the unattributed any qualifier and the default qualifier.
static final Attributes	anyQualifier()	Returns the unattributed any qualifier.
static final boolean	anyQualifier(Attributes a)	Returns true if and only if the supplied Attributes is equal to the unattributed any qualifier.
static final List<Attributes>	anyQualifiers()	Returns an immutable List consisting solely of the unattributed any qualifier.
static final Attributes	defaultQualifier()	Returns the default qualifier.
static final boolean	defaultQualifier(Attributes a)	Returns true if and only if the supplied Attributes is equal to the default qualifier.
static final List<Attributes>	defaultQualifiers()	Returns an immutable List consisting solely of the default qualifier.
static final List<Attributes>	normalize(List<Attributes> list)	Returns an immutable List of Attributess that is equal to the supplied List.
static final Attributes	normalize(Attributes a)	Returns an Attributes that is equal to the supplied Attributes.
static final Attributes	primordialQualifier()	Returns the primordial qualifier.
static final boolean	primordialQualifier(Attributes a)	Returns true if and only if the supplied Attributes is equal to the primordial qualifier.
static final List<Attributes>	primordialQualifiers()	Returns an immutable List consisting solely of the primordial qualifier.
static final Attributes	qualifier()	Returns the qualifier (meta-) qualifier.
static final boolean	qualifier(Attributes q)	Returns true if and only if the supplied Attributes is an Attributes that can be used to designate other Attributes as qualifiers.
static final List<Attributes>	qualifiers()	Returns an immutable List consisting solely of the qualifier (meta-) qualifier.
static final List<Attributes>	qualifiers(Collection<? extends Attributes> c)	Returns an unmodifiable List consisting only of those Attributes in the supplied Collection that are qualifiers.

Methods inherited from class java.lang.Object

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

Method Details

anyAndDefaultQualifiers

public static final List<Attributes> anyAndDefaultQualifiers()

Returns an unmodifiable List consisting solely of the unattributed any qualifier and the default qualifier.

Returns:

an unmodifiable List consisting solely of the unattributed any qualifier and the default qualifier; never null

See Also:

• anyQualifier()
• defaultQualifier()

anyQualifier

public static final Attributes anyQualifier()

Returns the unattributed any qualifier.

Returns:

the any qualifier; never null

See Also:

• anyQualifiers()

anyQualifier

public static final boolean anyQualifier(Attributes a)

Returns true if and only if the supplied Attributes is equal to the unattributed any qualifier.

Parameters:

a - an Attributes; must not be null

Returns:

true if and only if the supplied Attributes is equal to the unattributed any qualifier

Throws:

NullPointerException - if a is null

anyQualifiers

public static final List<Attributes> anyQualifiers()

Returns an immutable List consisting solely of the unattributed any qualifier.

Returns:

an immutable List; never null

See Also:

• anyQualifier()

defaultQualifier

public static final Attributes defaultQualifier()

Returns the default qualifier.

Returns:

the default qualifier; never null

See Also:

• defaultQualifiers()

defaultQualifier

public static final boolean defaultQualifier(Attributes a)

Returns true if and only if the supplied Attributes is equal to the default qualifier.

Parameters:

a - an Attributes; must not be null

Returns:

true if and only if the supplied Attributes is equal to the default qualifier

Throws:

NullPointerException - if a is null

defaultQualifiers

public static final List<Attributes> defaultQualifiers()

Returns an immutable List consisting solely of the default qualifier.

Returns:

an immutable List; never null

See Also:

• defaultQualifier()

normalize

public static final Attributes normalize(Attributes a)

Returns an Attributes that is equal to the supplied Attributes.

The returned Attributes may be the supplied Attributes or a different instance.

Parameters:

a - an Attributes; must not be null

Returns:

an Attributes that is equal to the supplied Attributes; never null

Throws:

NullPointerException - if a is null

normalize

public static final List<Attributes> normalize(List<Attributes> list)

Returns an immutable List of Attributess that is equal to the supplied List.

The returned List may be the supplied List or a different instance.

Parameters:

list - a List of Attributess; must not be null

Returns:

an immutable List of Attributess that is equal to the supplied List; never null

Throws:

NullPointerException - if list is null

primordialQualifier

public static final Attributes primordialQualifier()

Returns the primordial qualifier.

Returns:

the primordial qualifier; never null

See Also:

• primordialQualifiers()

primordialQualifier

public static final boolean primordialQualifier(Attributes a)

Returns true if and only if the supplied Attributes is equal to the primordial qualifier.

Parameters:

a - an Attributes; must not be null

Returns:

true if and only if the supplied Attributes is equal to the primordial qualifier

Throws:

NullPointerException - if a is null

primordialQualifiers

public static final List<Attributes> primordialQualifiers()

Returns an immutable List consisting solely of the primordial qualifier.

Returns:

an immutable List; never null

See Also:

• primordialQualifier()

qualifier

public static final Attributes qualifier()

Returns the qualifier (meta-) qualifier.

Returns:

the qualifier (meta-) qualifier; never null

qualifier

public static final boolean qualifier(Attributes q)

Returns true if and only if the supplied Attributes is an Attributes that can be used to designate other Attributes as qualifiers.

Parameters:

q - an Attributes; must not be null

Returns:

true if and only if the supplied Attributes is an Attributes that can be used to designate other Attributes as qualifiers

Throws:

NullPointerException - if q is null

qualifiers

public static final List<Attributes> qualifiers()

Returns an immutable List consisting solely of the qualifier (meta-) qualifier.

Returns:

an immutable List; never null

See Also:

• qualifier()

qualifiers

public static final List<Attributes> qualifiers(Collection<? extends Attributes> c)

Returns an unmodifiable List consisting only of those Attributes in the supplied Collection that are qualifiers.

Parameters:

c - a Collection of Attributess; must not be null

Returns:

an unmodifiable List consisting only of those Attributess in the supplied Collection that are qualifiers; never null

Throws:

NullPointerException - if c is null