Module org.klojang.check

Package org.klojang.check.relation

Enum Class Quantifier

java.lang.Object

java.lang.Enum<Quantifier>

org.klojang.check.relation.Quantifier

All Implemented Interfaces:

Serializable, Comparable<Quantifier>, Constable

public enum Quantifier
extends Enum<Quantifier>

Symbolic constants for logical quantifiers. ComposablePredicate and ComposableIntPredicate let you use logical quantifiers to define not just a relation between one value and another value, but also between one value and an array of other values:

 Check.that(list).is(notNull().and(contains(), noneOf(), "to", "be", "or", "not"));
 

(Strictly speaking the value domain of a logical quantifier would better be modeled as a Set. For convenience sake, however, it is modeled as a varargs array within Klojang Check.)

See Also:

• ComposablePredicate
• ComposableIntPredicate

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Symbolic constant for the universal quantifier (∀).
ANY	Symbolic constant for the existential quantifier (∃).
NONE	Symbolic constant for the negation of the existential quantifier (¬∃).

Method Summary

Modifier and Type	Method	Description
static Quantifier	allOf()	Returns ALL.
static Quantifier	anyOf()	Returns ANY.
static Quantifier	noneOf()	Returns NONE.
static Quantifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Quantifier[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final Quantifier ALL

Symbolic constant for the universal quantifier (∀).

ANY

public static final Quantifier ANY

Symbolic constant for the existential quantifier (∃).

NONE

public static final Quantifier NONE

Symbolic constant for the negation of the existential quantifier (¬∃).

Method Details

values

public static Quantifier[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Quantifier valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

allOf

public static Quantifier allOf()

Returns ALL.

Returns:

Quantifier.ALL

anyOf

public static Quantifier anyOf()

Returns ANY.

Returns:

Quantifier.ANY

noneOf

public static Quantifier noneOf()

Returns NONE.

Returns:

Quantifier.NONE