AbstractProperty (Open Traffic Sim core classes 0.03.01 API)

java.lang.Object
- org.opentrafficsim.simulationengine.properties.AbstractProperty<T>

Type Parameters:

T - type of the property

All Implemented Interfaces:

Iterable<AbstractProperty<T>>

Direct Known Subclasses:

BooleanProperty, CompoundProperty, ContinuousProperty, IntegerProperty, ProbabilityDistributionProperty, SelectionProperty, StringProperty
```
public abstract class AbstractProperty<T>
extends Object
implements Iterable<AbstractProperty<T>>
```
Abstract property.
Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-26 01:01:13 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1155 $, by $Author: averbraeck $, initial version 18 dec. 2014

Author:

Peter Knoppers

Constructor Summary

Constructors
Constructor and Description

AbstractProperty(int displayPriority)

Constructors
Constructor and Description
`AbstractProperty(int displayPriority)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract AbstractProperty<T>`	`deepCopy()` Construct a deep copy of this property (duplicates everything except immutable fields).
`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 String`	`htmlStateDescription()` Generate a description of the state of this property in HTML (excluding the <html> at the start and the </html> at the end.
`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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- 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
  - htmlStateDescription
```
public abstract String htmlStateDescription()
```
    Generate a description of the state of this property in HTML (excluding the <html> at the start and the </html> at the end. The result can be embedded in a html-table.
    
    Returns:
    
    String; the description of this property and the current state in HTML
  - deepCopy
```
public abstract AbstractProperty<T> deepCopy()
```
    Construct a deep copy of this property (duplicates everything except immutable fields).
    
    Returns:
    
    AbstractProperty<T>; a deep copy 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

Class AbstractProperty<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

AbstractProperty

Method Detail

getValue

getShortName

getDescription

setValue

isReadOnly

getDisplayPriority

htmlStateDescription

deepCopy

iterator

toString