Package org.opentrafficsim.base.parameters.constraint

Enum NumericConstraint

java.lang.Object

java.lang.Enum<NumericConstraint>

org.opentrafficsim.base.parameters.constraint.NumericConstraint

All Implemented Interfaces:

Serializable, Comparable<NumericConstraint>, Constraint<Number>

public enum NumericConstraint
extends Enum<NumericConstraint>
implements Constraint<Number>

List of default constraint for ParameterTypes.

Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 8 sep. 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATLEASTONE	Checks for ≥1.
NEGATIVE	Checks for <0.
NEGATIVEZERO	Checks for ≤0.
NONZERO	Checks for ≠0.
POSITIVE	Checks for >0.
POSITIVEZERO	Checks for ≥0.

Method Summary

Modifier and Type	Method	Description
String	failMessage()	Returns a message for value failure, pointing to a parameter using '%s'.
static NumericConstraint	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NumericConstraint[]	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

Methods inherited from interface org.opentrafficsim.base.parameters.constraint.Constraint

accept

Enum Constant Detail

POSITIVE

public static final NumericConstraint POSITIVE

Checks for >0.

NEGATIVE

public static final NumericConstraint NEGATIVE

Checks for <0.

POSITIVEZERO

public static final NumericConstraint POSITIVEZERO

Checks for ≥0.

NEGATIVEZERO

public static final NumericConstraint NEGATIVEZERO

Checks for ≤0.

NONZERO

public static final NumericConstraint NONZERO

Checks for ≠0.

ATLEASTONE

public static final NumericConstraint ATLEASTONE

Checks for ≥1.

Method Detail

values

public static NumericConstraint[] 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 (NumericConstraint c : NumericConstraint.values())
    System.out.println(c);

Returns:

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

valueOf

public static NumericConstraint valueOf(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:

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

NullPointerException - if the argument is null

failMessage

public String failMessage()

Returns a message for value failure, pointing to a parameter using '%s'.

Specified by:

failMessage in interface Constraint<Number>

Returns:

Message for value failure, pointing to a parameter using '%s'.