Property (Open Traffic Sim base classes 1.00.02 API)

Type Parameters:

T - Type of the property

All Superinterfaces:

Iterable<Property<?>>

All Known Implementing Classes:

AbstractProperty, BooleanProperty, CompoundProperty, ContinuousProperty, IntegerProperty, LongProperty, ProbabilityDistributionProperty, SelectionProperty, StringProperty
```
public interface Property<T>
extends Iterable<Property<?>>
```
User readable and settable properties.
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 Apr 22, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AbstractProperty<T>`	`deepCopy()` Construct a deep copy of this property (duplicates everything except immutable fields).
`Property<?>`	`findByKey(String propertyKey)` Retrieve a Property anywhere in this group that has the specified key.
`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.
`String`	`getKey()` Retrieve the key of this Property.
`CompoundProperty`	`getParent()` Retrieve the parent property.
`String`	`getShortName()` Return a short description of the property.
`T`	`getValue()` Retrieve the current value of the property.
`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.
`boolean`	`isReadOnly()` Return true if the property can not be altered.
`void`	`setValue(T newValue)` Change the value of the property.

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

- Method Detail
  - getValue
```
T getValue()
```
    Retrieve the current value of the property.
    
    Returns:
    
    T; the current value of the property
  - getShortName
```
String getShortName()
```
    Return a short description of the property.
    
    Returns:
    
    String; a short description of the property
  - getDescription
```
String getDescription()
```
    Return a description of the property (may use HTML markup).
    
    Returns:
    
    String; the description of the property
  - setValue
```
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
```
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
```
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
```
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 cell of a html-table.
    
    Returns:
    
    String; the description of this property and the current state in HTML
  - deepCopy
```
AbstractProperty<T> deepCopy()
```
    Construct a deep copy of this property (duplicates everything except immutable fields).
    
    Returns:
    
    AbstractProperty<T>; a deep copy of this AbstractProperty
  - findByKey
```
Property<?> findByKey(String propertyKey)
```
    Retrieve a Property anywhere in this group that has the specified key.
    
    Parameters:
    
    propertyKey - String; the key
    
    Returns:
    
    AbstractProperty; the matching AbstractProperty, or null if no property with the specified key exists in the group.
  - getKey
```
String getKey()
```
    Retrieve the key of this Property. The key is set at time of construction and it is immutable.
    
    Returns:
    
    String; the key of this Property
  - getParent
```
CompoundProperty getParent()
```
    Retrieve the parent property.
    
    Returns:
    
    Property<?>; the CompoundProperty that is the parent of this AbstractProperty (result is null if this property is not contained in a CompoundProperty)

Interface Property<T>

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

getValue

getShortName

getDescription

setValue

isReadOnly

getDisplayPriority

htmlStateDescription

deepCopy

findByKey

getKey

getParent