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:

• NamedAttributeMap

Method Summary

Modifier and Type	Method	Description
static final List<NamedAttributeMap<?>>	anyAndDefaultQualifiers()	Returns an unmodifiable List consisting solely of the any qualifier and the default qualifier.
static final NamedAttributeMap<?>	anyQualifier()	Returns the any qualifier.
static final boolean	anyQualifier(NamedAttributeMap<?> nam)	Returns true if and only if the supplied NamedAttributeMap is equal to the any qualifier.
static final List<NamedAttributeMap<?>>	anyQualifiers()	Returns an immutable List consisting solely of the any qualifier.
static final NamedAttributeMap<?>	defaultQualifier()	Returns the default qualifier.
static final boolean	defaultQualifier(NamedAttributeMap<?> nam)	Returns true if and only if the supplied NamedAttributeMap is equal to the default qualifier.
static final List<NamedAttributeMap<?>>	defaultQualifiers()	Returns an immutable List consisting solely of the default qualifier.
static final List<NamedAttributeMap<?>>	normalize(List<NamedAttributeMap<?>> list)	Returns an immutable List of NamedAttributeMaps that is equal to the supplied List.
static final NamedAttributeMap<?>	normalize(NamedAttributeMap<?> nam)	Returns a NamedAttributeMap that is equal to the supplied NamedAttributeMap.
static final NamedAttributeMap<?>	qualifier()	Returns the qualifier (meta-) qualifier.
static final boolean	qualifier(NamedAttributeMap<?> q)	Returns true if and only if the supplied NamedAttributeMap is itself a NamedAttributeMap that can be used to designate other NamedAttributeMaps as qualifiers, or a NamedAttributeMap so designated.
static final List<NamedAttributeMap<?>>	qualifiers(Collection<? extends NamedAttributeMap<?>> c)	Returns an unmodifiable List consisting only of those NamedAttributeMaps 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

anyQualifier

public static final NamedAttributeMap<?> anyQualifier()

Returns the any qualifier.

Returns:

the any qualifier; never null

See Also:

• anyQualifiers()

anyQualifier

public static final boolean anyQualifier(NamedAttributeMap<?> nam)

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

Parameters:

nam - a NamedAttributeMap; must not be null

Returns:

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

Throws:

NullPointerException - if nam is null

anyQualifiers

public static final List<NamedAttributeMap<?>> anyQualifiers()

Returns an immutable List consisting solely of the any qualifier.

Returns:

an immutable List; never null

See Also:

• anyQualifier()

anyAndDefaultQualifiers

public static final List<NamedAttributeMap<?>> anyAndDefaultQualifiers()

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

Returns:

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

See Also:

• anyQualifier()
• defaultQualifier()

defaultQualifier

public static final NamedAttributeMap<?> defaultQualifier()

Returns the default qualifier.

Returns:

the default qualifier; never null

See Also:

• defaultQualifiers()

defaultQualifier

public static final boolean defaultQualifier(NamedAttributeMap<?> nam)

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

Parameters:

nam - a NamedAttributeMap; must not be null

Returns:

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

Throws:

NullPointerException - if nam is null

defaultQualifiers

public static final List<NamedAttributeMap<?>> defaultQualifiers()

Returns an immutable List consisting solely of the default qualifier.

Returns:

an immutable List; never null

See Also:

• defaultQualifier()

qualifier

public static final NamedAttributeMap<?> qualifier()

Returns the qualifier (meta-) qualifier.

Returns:

the qualifier (meta-) qualifier; never null

qualifier

public static final boolean qualifier(NamedAttributeMap<?> q)

Returns true if and only if the supplied NamedAttributeMap is itself a NamedAttributeMap that can be used to designate other NamedAttributeMaps as qualifiers, or a NamedAttributeMap so designated.

A NamedAttributeMap whose name is Qualifier and whose metadata is empty is an example of the former.

A NamedAttributeMap whose metadata contains a NamedAttributeMap whose name is Qualifier is an example of the latter.

Parameters:

q - a NamedAttributeMap; must not be null

Returns:

true if and only if the supplied NamedAttributeMap is itself a NamedAttributeMap that can be used to designate other NamedAttributeMaps as qualifiers, or a NamedAttributeMap so designated

Throws:

NullPointerException - if nam is null

See Also:

• NamedAttributeMap.metadata()

qualifiers

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

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

Parameters:

c - a Collection of NamedAttributeMaps; must not be null

Returns:

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

Throws:

NullPointerException - if c is null

normalize

public static final NamedAttributeMap<?> normalize(NamedAttributeMap<?> nam)

Returns a NamedAttributeMap that is equal to the supplied NamedAttributeMap.

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

Parameters:

nam - a NamedAttributeMap; must not be null

Returns:

a NamedAttributeMap that is equal to the supplied NamedAttributeMap; never null

Throws:

NullPointerException - if nam is null

normalize

public static final List<NamedAttributeMap<?>> normalize(List<NamedAttributeMap<?>> list)

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

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

Parameters:

list - a List of NamedAttributeMaps; must not be null

Returns:

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

Throws:

NullPointerException - if list is null