org.opentrafficsim.base.modelproperties

Class PickList<T>

java.lang.Object

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

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

org.opentrafficsim.base.modelproperties.PickList<T>

Type Parameters:

T - type of the ids of the pick items

All Implemented Interfaces:

Serializable, Identifiable

public class PickList<T>
extends ParameterType<T>

Pick list with PickListItems.

Copyright (c) 2013-2018 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 Aug 14, 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary

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

defaultValue

Constructor Summary

Constructors

Constructor and Description
PickList(String id, String description, List<PickListItem<T>> items) Construct a new PickList and fill it with the provided items.
PickList(String id, String description, PickListItem<T> firstItem, PickListItem<T>... additionalItems) Construct a new PickList and fill it with the provided items.

Method Summary

Modifier and Type	Method and Description
void	addItem(PickListItem<T> item) Add one item to this PickList.
String	printValue(Parameters parameters) Print the given value from the map in Parameters in a presentable format.
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

PickList

@SafeVarargs
public PickList(String id,
                              String description,
                              PickListItem<T> firstItem,
                              PickListItem<T>... additionalItems)
                       throws ParameterException

Construct a new PickList and fill it with the provided items.

Parameters:

id - String; id of the new PickList

description - String; description of the new PickList

firstItem - PickList<T> the first item to add to the new PickList

additionalItems - PickList<T>...; any additional items to add to the new PickList; the reason for putting the first item in a separate argument is to ensure that this constructor cannot construct a PickList with zero items

Throws:

ParameterException - when the ids of the items are not all distinct

PickList

public PickList(String id,
                String description,
                List<PickListItem<T>> items)
         throws ParameterException

Construct a new PickList and fill it with the provided items.

Parameters:

id - String; id of the new PickList

description - String; description of the new PickList

items - List<PickListItem>; the items to add to the new PickList

Throws:

ParameterException - when the ids of the items are not all distinct

Method Detail

addItem

public final void addItem(PickListItem<T> item)
                   throws ParameterException

Add one item to this PickList.

Parameters:

item - PickListItem<T>; the item to add

Throws:

ParameterException - when the id of the provided item matches an existing item

printValue

public 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 ParameterType<T>

Parameters:

parameters - Parameters to get the value from

Returns:

String; readable representation of the value

Throws:

ParameterException - If the parameter is not present

toString

public String toString()

Overrides:

toString in class ParameterType<T>