me.zeroeightsix.fiber.api.constraint

Enum ConstraintType

java.lang.Object

java.lang.Enum<ConstraintType>

me.zeroeightsix.fiber.api.constraint.ConstraintType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ConstraintType>

public enum ConstraintType
extends java.lang.Enum<ConstraintType>

A set of constraint types Fiber supports.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPONENTS_MATCH Specifies that all elements of a collection or array must satisfy all of a constraint's child constraints in order to satisfy that constraint.
COMPOSITE Specifies that a constraint is a composite constraint.
FINAL Indicates that the value can never be changed after initialization
MAXIMUM_LENGTH Specifies a maximum length.
MINIMUM_LENGTH Specifies a minimum length.
NUMERICAL_LOWER_BOUND Specifies a numerical lower bound.
NUMERICAL_UPPER_BOUND Specifies a numerical upper bound.
STRING_MATCHING Specifies a pattern that must match.

Method Summary

Modifier and Type	Method and Description
FiberId	getIdentifier() Returns the unique identifier for this ConstraintType.
boolean	isNumerical() Returns whether or not this is a ConstraintType that operates only on numerical values
static ConstraintType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConstraintType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FINAL

public static final ConstraintType FINAL

Indicates that the value can never be changed after initialization

NUMERICAL_LOWER_BOUND

public static final ConstraintType NUMERICAL_LOWER_BOUND

Specifies a numerical lower bound.

Values must be equal to or greater than the constraint's value to satisfy the constraint.

NUMERICAL_UPPER_BOUND

public static final ConstraintType NUMERICAL_UPPER_BOUND

Specifies a numerical upper bound.

Values must be equal to or lesser than the constraint's value to satisfy the constraint.

MINIMUM_LENGTH

public static final ConstraintType MINIMUM_LENGTH

Specifies a minimum length. This constraint applies to CharSequences, Collections and arrays.

Values must be of equal or longer length than the constraint's value to satisfy the constraint. For example: a constraint that is checking strings has this constraint type and value 3.

• "AB" would not satisfy the constraint
• "ABC" and "ABCD" would satisfy the constraint

See Also:

MAXIMUM_LENGTH

MAXIMUM_LENGTH

public static final ConstraintType MAXIMUM_LENGTH

Specifies a maximum length. This constraint applies to CharSequences, Collections and arrays.

Values must be of equal or shorter length than the constraint's value to satisfy the constraint. For example: a constraint that is checking strings has this constraint type and value 3.

• "AB" and "ABC" would satisfy the constraint
• "ABCD" would not satisfy the constraint

See Also:

MINIMUM_LENGTH

STRING_MATCHING

public static final ConstraintType STRING_MATCHING

Specifies a pattern that must match.

Values must match the constraint's value, which is a regular expression (regex).

COMPONENTS_MATCH

public static final ConstraintType COMPONENTS_MATCH

Specifies that all elements of a collection or array must satisfy all of a constraint's child constraints in order to satisfy that constraint.

COMPOSITE

public static final ConstraintType COMPOSITE

Specifies that a constraint is a composite constraint.

Whether or not a value satisfies a composite constraint is specified by the composite's CompositeType.

Method Detail

values

public static ConstraintType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConstraintType c : ConstraintType.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConstraintType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isNumerical

public boolean isNumerical()

Returns whether or not this is a ConstraintType that operates only on numerical values

Returns:

true if this type is numerical

getIdentifier

public FiberId getIdentifier()

Returns the unique identifier for this ConstraintType.

Returns:

the identifier