org.opentrafficsim.simulationengine

Class AbstractProperty<T>

java.lang.Object

org.opentrafficsim.simulationengine.AbstractProperty<T>

Type Parameters:

T - type of the property

All Implemented Interfaces:

Iterable<AbstractProperty<T>>

Direct Known Subclasses:

BooleanProperty, CompoundProperty, ContinuousProperty, IntegerProperty, ProbabilityDistributionProperty, SelectionProperty

public abstract class AbstractProperty<T>
extends Object
implements Iterable<AbstractProperty<T>>

Abstract property.

Copyright (c) 2013-2014 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

18 dec. 2014

Author:

Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
AbstractProperty(int displayPriority)

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getDescription() Return a description of the property (may use HTML markup).
int	getDisplayPriority() Display priority determines the order in which properties should be displayed.
abstract String	getShortName() Return a short description of the property.
abstract T	getValue() Retrieve the current value of the property.
abstract boolean	isReadOnly() Return true if the property can not be altered.
Iterator<AbstractProperty<T>>	iterator()
abstract void	setValue(T newValue) Change the value of the property.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProperty

public AbstractProperty(int displayPriority)

Parameters:

displayPriority - sorting order when properties are displayed to the user.

Method Detail

getValue

public abstract T getValue()

Retrieve the current value of the property.

Returns:

T; the current value of the property

getShortName

public abstract String getShortName()

Return a short description of the property.

Returns:

String; a short description of the property

getDescription

public abstract String getDescription()

Return a description of the property (may use HTML markup).

Returns:

String; the description of the property

setValue

public abstract void setValue(T newValue)
                       throws PropertyException

Change the value of the property.

Parameters:

newValue - T; the new value for the property

Throws:

PropertyException - when this Property is read-only, or newValue is not valid

isReadOnly

public abstract boolean isReadOnly()

Return true if the property can not be altered.

Returns:

boolean; true if this property can not be altered, false if this property can be altered

getDisplayPriority

public final int getDisplayPriority()

Display priority determines the order in which properties should be displayed. Properties with lower values should be displayed above or before those with higher values.

Returns:

int; the display priority of this AbstractProperty

iterator

public final Iterator<AbstractProperty<T>> iterator()

Specified by:

iterator in interface Iterable<AbstractProperty<T>>

toString

public final String toString()

Overrides:

toString in class Object