org.opentrafficsim.core.gtu.behavioralcharacteristics

Class AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>

java.lang.Object

org.opentrafficsim.base.Type<AbstractParameterType<?>>

org.opentrafficsim.core.gtu.behavioralcharacteristics.AbstractParameterType<T>

Type Parameters:

T - Class of the value.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ParameterType, ParameterTypeBoolean, ParameterTypeDouble, ParameterTypeInteger

public abstract class AbstractParameterType<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface>
extends org.opentrafficsim.base.Type<AbstractParameterType<?>>
implements Serializable

Defines meta-information of a parameter, defining the parameter uniquely.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractParameterType.Check List of default checks for ParameterTypes.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	defaultValue Default value.
protected Class<T>	valueClass Class of the value.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractParameterType(String id, String description, Class<T> valueClass) Constructor without default value and check.
	AbstractParameterType(String id, String description, Class<T> valueClass, AbstractParameterType.Check check) Constructor without default value, with check.
	AbstractParameterType(String id, String description, Class<T> valueClass, T defaultValue) Constructor with default value, without check.
	AbstractParameterType(String id, String description, Class<T> valueClass, T defaultValue, AbstractParameterType.Check check) Constructor with default value and check.
protected	AbstractParameterType(String id, String description, Class<T> valueClass, T defaultValue, AbstractParameterType.Check check, boolean hasDefaultValue) Protected constructor with default value and check, which may check the default value.

Method Summary

Modifier and Type	Method and Description
protected void	checkCheck(T value) Checks the default checks given with the parameter type.
boolean	equals(Object obj)
abstract Object	getDefaultValue() Returns the default value.
String	getDescription() Returns the parameter description.
String	getId() Returns the parameter id.
boolean	hasDefaultValue() Returns whether this parameter type has a default value.
int	hashCode()
abstract String	printValue(BehavioralCharacteristics behavioralCharacteristics) Print the given value from the map in BehavioralCharachteristics in a presentable format.
String	toString()

Methods inherited from class org.opentrafficsim.base.Type

isType

Methods inherited from class java.lang.Object

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

Field Detail

valueClass

protected final Class<T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface> valueClass

Class of the value.

defaultValue

protected final T extends org.djunits.value.vdouble.scalar.DoubleScalarInterface defaultValue

Default value.

Constructor Detail

AbstractParameterType

public AbstractParameterType(String id,
                             String description,
                             Class<T> valueClass)

Constructor without default value and check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

AbstractParameterType

public AbstractParameterType(String id,
                             String description,
                             Class<T> valueClass,
                             T defaultValue)

Constructor with default value, without check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

defaultValue - Default value.

AbstractParameterType

public AbstractParameterType(String id,
                             String description,
                             Class<T> valueClass,
                             AbstractParameterType.Check check)

Constructor without default value, with check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

check - Check for parameter values.

AbstractParameterType

public AbstractParameterType(String id,
                             String description,
                             Class<T> valueClass,
                             T defaultValue,
                             AbstractParameterType.Check check)

Constructor with default value and check.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

defaultValue - Default value.

check - Check for parameter values.

AbstractParameterType

protected AbstractParameterType(String id,
                                String description,
                                Class<T> valueClass,
                                T defaultValue,
                                AbstractParameterType.Check check,
                                boolean hasDefaultValue)

Protected constructor with default value and check, which may check the default value.

Parameters:

id - Short name of parameter.

description - Parameter description or full name.

valueClass - Class of the value.

defaultValue - Default value.

check - Check for parameter values.

hasDefaultValue - Whether to check the default value for null.

Method Detail

getId

public final String getId()

Returns the parameter id.

Returns:

id Parameter id.

getDescription

public final String getDescription()

Returns the parameter description.

Returns:

description

hasDefaultValue

public final boolean hasDefaultValue()

Returns whether this parameter type has a default value.

Returns:

Whether this parameter type has a default value.

getDefaultValue

public abstract Object getDefaultValue()
                                throws ParameterException

Returns the default value.

Returns:

defaultValue Default value.

Throws:

ParameterException - If no default value was set.

checkCheck

protected final void checkCheck(T value)
                         throws ParameterException

Checks the default checks given with the parameter type.

Parameters:

value - The value to check.

Throws:

ParameterException - If the value does not comply with constraints.

printValue

public abstract String printValue(BehavioralCharacteristics behavioralCharacteristics)
                           throws ParameterException

Print the given value from the map in BehavioralCharachteristics in a presentable format.

Parameters:

behavioralCharacteristics - Behavioral characteristics to get the value from.

Returns:

Printable string of value.

Throws:

ParameterException - If the parameter is not present.

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object