AbstractProperty (Open Traffic Sim base classes 1.00.02 API)

java.lang.Object
- org.opentrafficsim.base.modelproperties.AbstractProperty<T>

Type Parameters:

T - type of the property

All Implemented Interfaces:

Serializable, Iterable<Property<?>>, Property<T>

Direct Known Subclasses:

BooleanProperty, CompoundProperty, ContinuousProperty, IntegerProperty, LongProperty, ProbabilityDistributionProperty, SelectionProperty, StringProperty
```
public abstract class AbstractProperty<T>
extends Object
implements Property<T>, Serializable
```
Abstract property.
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.
$LastChangedDate: 2016-05-28 11:33:31 +0200 (Sat, 28 May 2016) $, @version $Revision: 2051 $, by $Author: averbraeck $, initial version 18 dec. 2014

Author:

Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AbstractProperty(String key, int displayPriority, String shortName, String description)` Construct a new AbstractProperty.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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 AbstractProperty.
`CompoundProperty`	`getParent()` Retrieve the parent property.
`String`	`getShortName()` Return a short description 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.
`boolean`	`isReadOnly()` Return true if the property can not be altered.
`Iterator<Property<?>>`	`iterator()`
`protected void`	`setParent(CompoundProperty newParent)` Set the parent of this AbstractProperty.
`void`	`setReadOnly(boolean readOnlyValue)` Finalize the readOnly flag.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opentrafficsim.base.modelproperties.Property
deepCopy, getValue, setValue

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

- Constructor Detail
  - AbstractProperty
```
public AbstractProperty(String key,
                        int displayPriority,
                        String shortName,
                        String description)
```
    Construct a new AbstractProperty.
    
    Parameters:
    
    key - String; unique (within this property tree) name of the new AbstractProperty
    
    displayPriority - sorting order when properties are displayed to the user
    
    shortName - String; concise description of the property
    
    description - String; long description of the property (may use HTML markup)
- Method Detail
  - setReadOnly
```
public final void setReadOnly(boolean readOnlyValue)
```
    Finalize the readOnly flag.
    
    Parameters:
    
    readOnlyValue - boolean; the new value for the readonly flag
  - 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.
    
    Specified by:
    
    getDisplayPriority in interface Property<T>
    
    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 cell of a html-table.
    
    Specified by:
    
    htmlStateDescription in interface Property<T>
    
    Returns:
    
    String; the description of this property and the current state in HTML
  - iterator
```
public final Iterator<Property<?>> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Property<?>>
  - getShortName
```
public final String getShortName()
```
    Return a short description of the property.
    
    Specified by:
    
    getShortName in interface Property<T>
    
    Returns:
    
    String; a short description of the property
  - getDescription
```
public final String getDescription()
```
    Return a description of the property (may use HTML markup).
    
    Specified by:
    
    getDescription in interface Property<T>
    
    Returns:
    
    String; the description of the property
  - isReadOnly
```
public final boolean isReadOnly()
```
    Return true if the property can not be altered.
    
    Specified by:
    
    isReadOnly in interface Property<T>
    
    Returns:
    
    boolean; true if this property can not be altered, false if this property can be altered
  - getKey
```
public final String getKey()
```
    Retrieve the key of this AbstractProperty.
    
    Specified by:
    
    getKey in interface Property<T>
    
    Returns:
    
    String; the key of this AbstractProperty
  - findByKey
```
public final Property<?> findByKey(String propertyKey)
```
    Retrieve a Property anywhere in this group that has the specified key.
    
    Specified by:
    
    findByKey in interface Property<T>
    
    Parameters:
    
    propertyKey - String; the key
    
    Returns:
    
    AbstractProperty; the matching AbstractProperty, or null if no property with the specified key exists in the group.
  - setParent
```
protected final void setParent(CompoundProperty newParent)
```
    Set the parent of this AbstractProperty.
    
    Parameters:
    
    newParent - AbstractProperty<?>; the new parent of this AbstractProperty
  - getParent
```
public final CompoundProperty getParent()
```
    Retrieve the parent property.
    
    Specified by:
    
    getParent in interface Property<T>
    
    Returns:
    
    Property<?>; the CompoundProperty that is the parent of this AbstractProperty (result is null if this property is not contained in a CompoundProperty)
  - 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 org.opentrafficsim.base.modelproperties.Property

Methods inherited from interface java.lang.Iterable

Constructor Detail

AbstractProperty

Method Detail

setReadOnly

getDisplayPriority

htmlStateDescription

iterator

getShortName

getDescription

isReadOnly

getKey

findByKey

setParent

getParent

toString