Package org.opentrafficsim.base.parameters

Class ParameterTypeInteger

java.lang.Object

org.opentrafficsim.base.Type<ParameterType<T>>

org.opentrafficsim.base.parameters.ParameterType<T>

org.opentrafficsim.base.parameters.ParameterTypeNumeric<java.lang.Integer>

org.opentrafficsim.base.parameters.ParameterTypeInteger

All Implemented Interfaces:

java.io.Serializable, Identifiable

public class ParameterTypeInteger
extends ParameterTypeNumeric<java.lang.Integer>
implements java.io.Serializable

Wrapper class for int parameters.

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 Apr 13, 2016

Author:

Alexander Verbraeck, Wouter Schakel

See Also:

Serialized Form

Field Summary

Fields inherited from class org.opentrafficsim.base.parameters.ParameterType

defaultValue

Constructor Summary

Constructors

Constructor	Description
ParameterTypeInteger(java.lang.String id, java.lang.String description)	Construct a new ParameterTypeInteger without default value and check.
ParameterTypeInteger(java.lang.String id, java.lang.String description, int defaultValue)	Construct a new ParameterTypeInteger with default value, without check.
ParameterTypeInteger(java.lang.String id, java.lang.String description, int defaultValue, Constraint<? super java.lang.Integer> constraint)	Construct a new ParameterTypeInteger with default value and check.
ParameterTypeInteger(java.lang.String id, java.lang.String description, java.lang.Integer defaultValue)	Construct a new ParameterTypeInteger with default value, without check.
ParameterTypeInteger(java.lang.String id, java.lang.String description, java.lang.Integer defaultValue, Constraint<java.lang.Number> constraint)	Construct a new ParameterTypeInteger with default value and check.
ParameterTypeInteger(java.lang.String id, java.lang.String description, Constraint<? super java.lang.Integer> constraint)	Construct a new ParameterTypeInteger without default value, with check.

Method Summary

Modifier and Type	Method	Description
void	check(int value, Parameters params)	Method to overwrite for checks with constraints.
java.lang.String	printValue(Parameters parameters)	Print the given value from the map in Parameters in a presentable format.
java.lang.String	toString()

Methods inherited from class org.opentrafficsim.base.parameters.ParameterType

check, checkConstraint, equals, getConstraint, getDefaultValue, getDescription, getId, getValueClass, hasDefaultValue, hashCode

Methods inherited from class org.opentrafficsim.base.Type

isType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterTypeInteger

public ParameterTypeInteger(java.lang.String id,
                            java.lang.String description)

Construct a new ParameterTypeInteger without default value and check.

Parameters:

id - String; short name of the new ParameterTypeInteger

description - String; parameter description or full name of the new ParameterTypeInteger

ParameterTypeInteger

public ParameterTypeInteger(java.lang.String id,
                            java.lang.String description,
                            int defaultValue)

Construct a new ParameterTypeInteger with default value, without check.

Parameters:

id - String; short name of the new ParameterTypeInteger

description - String; parameter description or full name of the new ParameterTypeInteger

defaultValue - int; the default value of the new ParameterTypeInteger

ParameterTypeInteger

public ParameterTypeInteger(java.lang.String id,
                            java.lang.String description,
                            java.lang.Integer defaultValue)

Construct a new ParameterTypeInteger with default value, without check.

Parameters:

id - String; short name of the new ParameterTypeInteger

description - String; parameter description or full name of the new ParameterTypeInteger

defaultValue - Integer; the default value of the new ParameterTypeInteger

ParameterTypeInteger

public ParameterTypeInteger(java.lang.String id,
                            java.lang.String description,
                            Constraint<? super java.lang.Integer> constraint)

Construct a new ParameterTypeInteger without default value, with check.

Parameters:

id - String; short name of the new ParameterTypeInteger

description - String; parameter description or full name of the new ParameterTypeInteger

constraint - Constraint<? super Integer>; constraint for parameter values

ParameterTypeInteger

public ParameterTypeInteger(java.lang.String id,
                            java.lang.String description,
                            int defaultValue,
                            Constraint<? super java.lang.Integer> constraint)

Construct a new ParameterTypeInteger with default value and check.

Parameters:

id - String; short name of the new ParameterTypeInteger

description - String; parameter description or full name of the new ParameterTypeInteger

defaultValue - int; the default value of the new ParameterTypeInteger

constraint - Constraint<? super Integer>; constraint for parameter values

ParameterTypeInteger

public ParameterTypeInteger(java.lang.String id,
                            java.lang.String description,
                            java.lang.Integer defaultValue,
                            Constraint<java.lang.Number> constraint)

Construct a new ParameterTypeInteger with default value and check.

Parameters:

id - String; short name of the new ParameterTypeInteger

description - String; parameter description or full name of the new ParameterTypeInteger

defaultValue - Integer; the default value of the new ParameterTypeInteger

constraint - Constraint<Number>; constraint for parameter values

Method Detail

printValue

public final java.lang.String printValue(Parameters parameters)
                                  throws ParameterException

Print the given value from the map in Parameters in a presentable format. The default implementation simply returns the output of toString().

Overrides:

printValue in class ParameterTypeNumeric<java.lang.Integer>

Parameters:

parameters - Parameters; Parameters to get the value from

Returns:

String; readable representation of the value

Throws:

ParameterException - If the parameter is not present

check

public void check(int value,
                  Parameters params)
           throws ParameterException

Method to overwrite for checks with constraints.

Parameters:

value - int; Value to check with constraints.

params - Parameters; Set of parameters.

Throws:

ParameterException - If the value does not comply with constraints.

toString

public java.lang.String toString()

Overrides:

toString in class ParameterTypeNumeric<java.lang.Integer>