AbstractParameterType.Check (Open Traffic Sim core classes 0.14.00 API)

java.lang.Object
- java.lang.Enum<AbstractParameterType.Check>
- - org.opentrafficsim.core.gtu.behavioralcharacteristics.AbstractParameterType.Check

All Implemented Interfaces:

Serializable, Comparable<AbstractParameterType.Check>

Enclosing class:

AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>
```
public static enum AbstractParameterType.Check
extends Enum<AbstractParameterType.Check>
```
List of default checks for ParameterTypes.

Enum Constant Summary

Enum Constants
Enum Constant and 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.
`UNITINTERVAL` Checks for range [0...1].

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) String`	`failMessage()` Returns a message for value failure, pointing to a parameter using '%s'.
`(package private) abstract boolean`	`fails(double value)` Checks whether the value fails to comply with constraints.
`static AbstractParameterType.Check`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AbstractParameterType.Check[]`	`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
  - POSITIVE
```
public static final AbstractParameterType.Check POSITIVE
```
    Checks for >0.
  - NEGATIVE
```
public static final AbstractParameterType.Check NEGATIVE
```
    Checks for <0.
  - POSITIVEZERO
```
public static final AbstractParameterType.Check POSITIVEZERO
```
    Checks for ≥0.
  - NEGATIVEZERO
```
public static final AbstractParameterType.Check NEGATIVEZERO
```
    Checks for ≤0.
  - NONZERO
```
public static final AbstractParameterType.Check NONZERO
```
    Checks for ≠0.
  - UNITINTERVAL
```
public static final AbstractParameterType.Check UNITINTERVAL
```
    Checks for range [0...1].
  - ATLEASTONE
```
public static final AbstractParameterType.Check ATLEASTONE
```
    Checks for ≥1.
- Method Detail
  - values
```
public static AbstractParameterType.Check[] 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 (AbstractParameterType.Check c : AbstractParameterType.Check.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AbstractParameterType.Check 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
```
String failMessage()
```
    Returns a message for value failure, pointing to a parameter using '%s'.
    
    Returns:
    
    Message for value failure, pointing to a parameter using '%s'.
  - fails
```
abstract boolean fails(double value)
```
    Checks whether the value fails to comply with constraints.
    
    Parameters:
    
    value - Value to check.
    
    Returns:
    
    Whether the value fails to comply with constraints.

Enum AbstractParameterType.Check

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

POSITIVE

NEGATIVE

POSITIVEZERO

NEGATIVEZERO

NONZERO

UNITINTERVAL

ATLEASTONE

Method Detail

values

valueOf

failMessage

fails