org.opentrafficsim.base.modelproperties

Class PickListItem<T>

java.lang.Object

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

Type Parameters:

T - type of the pick ids (usually String or Integer)

public class PickListItem<T>
extends Object

Value that can be used in a PickList.

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

Constructor Summary

Constructors

Constructor and Description
PickListItem(T id, String displayText) Construct a new PickListItem.
PickListItem(T id, String displayText, String description) Construct a new PickListItem.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Retrieve the description of this PickListItem.
String	getDisplayText() Retrieve the display text of this PickListItem.
T	getId() Retrieve the id of this PickListItem.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PickListItem

public PickListItem(T id,
                    String displayText,
                    String description)

Construct a new PickListItem.

Parameters:

id - T; the id of the new PickListItem

displayText - String; the text to show to the user in the pick list

description - String; the description of this pick list item (may use HTML formatting)

PickListItem

public PickListItem(T id,
                    String displayText)

Construct a new PickListItem.

Parameters:

id - T; the id of the new PickListItem

displayText - String; the text to show to the user in the pick list; also used for the description

Method Detail

getId

public final T getId()

Retrieve the id of this PickListItem.

Returns:

T; the id of this PickListItem

getDisplayText

public final String getDisplayText()

Retrieve the display text of this PickListItem.

Returns:

String; the display text of this PickListItem

getDescription

public final String getDescription()

Retrieve the description of this PickListItem.

Returns:

String; the description of this PickListItem

toString

public String toString()

Overrides:

toString in class Object