CompoundProperty (Open Traffic Sim core classes 0.10.00 API)

java.lang.Object
- org.opentrafficsim.simulationengine.properties.AbstractProperty<List<AbstractProperty<?>>>
- - org.opentrafficsim.simulationengine.properties.CompoundProperty

All Implemented Interfaces:

Serializable, Iterable<AbstractProperty<List<AbstractProperty<?>>>>, Property<List<AbstractProperty<?>>>
```
public class CompoundProperty
extends AbstractProperty<List<AbstractProperty<?>>>
implements Serializable
```
Compound property.
Copyright (c) 2013-2016 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 30 dec. 2014

Author:

Peter Knoppers

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.opentrafficsim.simulationengine.properties.AbstractProperty
  AbstractProperty.PropertyIterator

Constructor Summary

Constructors
Constructor and Description
`CompoundProperty(String key, String shortName, String description, List<AbstractProperty<?>> initialValue, boolean readOnly, int displayPriority)` Construct a CompoundProperty.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(AbstractProperty<?> ap)` Add an AbstractProperty at the end of the list.
`void`	`add(int index, AbstractProperty<?> ap)` Add an AbstractProperty at a specified position.
`AbstractProperty<List<AbstractProperty<?>>>`	`deepCopy()` Construct a deep copy of this property (duplicates everything except immutable fields).
`List<AbstractProperty<?>>`	`displayOrderedValue()` Return the sub-items in display order.
`AbstractProperty<?>`	`findSubPropertyByKey(String key)` Find an embedded AbstractProperty that has a specified shortName.
`AbstractProperty<?>`	`get(int index)` Return the sub property at a specified index.
`protected Map<String,AbstractProperty<?>>`	`getPropertyGroup()` Retrieve the property group.
`List<AbstractProperty<?>>`	`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.
`void`	`remove(AbstractProperty<?> removeMe)` Remove a property from this CompoundProperty.
`void`	`remove(int index)` Remove a sub property from this CompoundProperty.
`protected void`	`setPropertyGroup(Map<String,AbstractProperty<?>> newPropertyGroup)` Update the property group when this CompoundProperty is added or removed from another CompoundProperty.
`void`	`setValue(List<AbstractProperty<?>> newValue)` Change the value of the property.
`int`	`size()` Return the number of sub properties of this CompoundProperty.

Methods inherited from class org.opentrafficsim.simulationengine.properties.AbstractProperty
findByKey, getDescription, getDisplayPriority, getKey, getParent, getShortName, isReadOnly, iterator, setParent, setReadOnly, 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
  - CompoundProperty
```
public CompoundProperty(String key,
                        String shortName,
                        String description,
                        List<AbstractProperty<?>> initialValue,
                        boolean readOnly,
                        int displayPriority)
                 throws PropertyException
```
    Construct a CompoundProperty.
    
    Parameters:
    
    key - String; the unique key of the new property
    
    shortName - String; the short name of the new CompoundProperty
    
    description - String; description of the new CompoundProperty (may use HTML mark up)
    
    initialValue - Integer; the initial value of the new CompoundProperty
    
    readOnly - boolean; if true this CompoundProperty can not be altered
    
    displayPriority - int; the display priority of the new CompoundProperty
    
    Throws:
    
    PropertyException - if key is already in use
- Method Detail
  - getValue
```
public final List<AbstractProperty<?>> getValue()
```
    Retrieve the current value of the property.
    
    Specified by:
    
    getValue in interface Property<List<AbstractProperty<?>>>
    
    Returns:
    
    T; the current value of the property
  - setValue
```
public final void setValue(List<AbstractProperty<?>> newValue)
                    throws PropertyException
```
    Change the value of the property.
    
    Specified by:
    
    setValue in interface Property<List<AbstractProperty<?>>>
    
    Parameters:
    
    newValue - T; the new value for the property
    
    Throws:
    
    PropertyException - when this Property is read-only, or newValue is not valid
  - findSubPropertyByKey
```
public final AbstractProperty<?> findSubPropertyByKey(String key)
```
    Find an embedded AbstractProperty that has a specified shortName.
    Return the first matching one, or null if none of the embedded AbstractProperties has the specified name.
    
    Parameters:
    
    key - String; the key of the sought embedded AbstractProperty
    
    Returns:
    
    AbstractProperty<?>; the first matching embedded AbstractProperty or null if there is no embedded AbstractProperty with the specified name
  - add
```
public final void add(int index,
                      AbstractProperty<?> ap)
               throws PropertyException
```
    Add an AbstractProperty at a specified position.
    
    Parameters:
    
    index - int; the position where the AbstractProperty must be added
    
    ap - AbstractProperty; the property to add
    
    Throws:
    
    PropertyException - when this CompoundProperty is read-only, or index is out of range
  - add
```
public final void add(AbstractProperty<?> ap)
               throws PropertyException
```
    Add an AbstractProperty at the end of the list.
    
    Parameters:
    
    ap - AbstractProperty; the property to add
    
    Throws:
    
    PropertyException - when this CompoundProperty is read-only
  - remove
```
public final void remove(int index)
                  throws PropertyException
```
    Remove a sub property from this CompoundProperty.
    
    Parameters:
    
    index - int; the position of the sub property to remove
    
    Throws:
    
    PropertyException - when this CompoundProperty is read-only, or index is out of range
  - remove
```
public final void remove(AbstractProperty<?> removeMe)
                  throws PropertyException
```
    Remove a property from this CompoundProperty.
    
    Parameters:
    
    removeMe - AbstractProperty the property that must be removed
    
    Throws:
    
    PropertyException - when the supplied property cannot be removed (probably because it is not part of this CompoundProperty)
  - size
```
public final int size()
```
    Return the number of sub properties of this CompoundProperty.
    
    Returns:
    
    int; the number of sub properties of this CompoundProperty
  - setPropertyGroup
```
protected final void setPropertyGroup(Map<String,AbstractProperty<?>> newPropertyGroup)
```
    Update the property group when this CompoundProperty is added or removed from another CompoundProperty.
    
    Parameters:
    
    newPropertyGroup - Map<String, AbstractProperty<?>>; if non-null; this is the property group of the new parent which we are now part of and we must use that in lieu of our own; if null; we are being removed from our parent and we must rebuild our own property group
  - get
```
public final AbstractProperty<?> get(int index)
                              throws PropertyException
```
    Return the sub property at a specified index.
    
    Parameters:
    
    index - int; the index of the property to retrieve
    
    Returns:
    
    AbstractProperty; the sub property at the specified index
    
    Throws:
    
    PropertyException - when index is out of range
  - displayOrderedValue
```
public final List<AbstractProperty<?>> displayOrderedValue()
```
    Return the sub-items in display order.
    
    Returns:
    
    ArrayList<AbstractProperty<?>>; the sub-items in display order
  - htmlStateDescription
```
public final 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.
    
    Specified by:
    
    htmlStateDescription in interface Property<List<AbstractProperty<?>>>
    
    Specified by:
    
    htmlStateDescription in class AbstractProperty<List<AbstractProperty<?>>>
    
    Returns:
    
    String; the description of this property and the current state in HTML
  - deepCopy
```
public final AbstractProperty<List<AbstractProperty<?>>> deepCopy()
```
    Construct a deep copy of this property (duplicates everything except immutable fields).
    
    Specified by:
    
    deepCopy in interface Property<List<AbstractProperty<?>>>
    
    Returns:
    
    AbstractProperty<T>; a deep copy of this AbstractProperty
  - getPropertyGroup
```
protected final Map<String,AbstractProperty<?>> getPropertyGroup()
```
    Retrieve the property group. DO NOT MODIFY the result.
    
    Returns:
    
    Map<String, AbstractProperty<?>>; the property group map

Class CompoundProperty

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.simulationengine.properties.AbstractProperty

Constructor Summary

Method Summary

Methods inherited from class org.opentrafficsim.simulationengine.properties.AbstractProperty

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

CompoundProperty

Method Detail

getValue

setValue

findSubPropertyByKey

add

add

remove

remove

size

setPropertyGroup

get

displayOrderedValue

htmlStateDescription

deepCopy

getPropertyGroup