Package org.opentrafficsim.base.parameters.constraint

Enum NumericConstraint

java.lang.Object
java.lang.Enum<NumericConstraint>
org.opentrafficsim.base.parameters.constraint.NumericConstraint
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<NumericConstraint>, java.lang.constant.Constable, Constraint<java.lang.Number>
public enum NumericConstraint
extends java.lang.Enum<NumericConstraint>
implements Constraint<java.lang.Number>
List of default constraint for ParameterTypes.

Copyright (c) 2013-2019 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

  • Nested Class Summary

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

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • 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
    java.lang.String failMessage()
    Returns a message for value failure, pointing to a parameter using '%s'.
    static NumericConstraint valueOf​(java.lang.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, describeConstable, 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 Details

  • Method Details

    • values

      public static NumericConstraint[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static NumericConstraint 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

    • failMessage

      public java.lang.String failMessage()
      Returns a message for value failure, pointing to a parameter using '%s'.
      Specified by:
      failMessage in interface Constraint<java.lang.Number>
      Returns:
      Message for value failure, pointing to a parameter using '%s'.