org.opentrafficsim.simulationengine

Class CompoundProperty

java.lang.Object

org.opentrafficsim.simulationengine.AbstractProperty<ArrayList<AbstractProperty<?>>>

org.opentrafficsim.simulationengine.CompoundProperty

All Implemented Interfaces:

Iterable<AbstractProperty<ArrayList<AbstractProperty<?>>>>

public class CompoundProperty
extends AbstractProperty<ArrayList<AbstractProperty<?>>>

Compound 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:

30 dec. 2014

Author:

Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
CompoundProperty(String shortName, String description, ArrayList<AbstractProperty<?>> initialValue, boolean readOnly, int displayPriority) Construct an CompoundProperty.

Method Summary

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.
ArrayList<AbstractProperty<?>>	displayOrderedValue() Return the sub-items in display order.
AbstractProperty<?>	findByShortName(String name) Find an embedded AbstractProperty that has a specified shortName.
AbstractProperty<?>	get(int index) Return the sub property at a specified index.
String	getDescription() Return a description of the property (may use HTML markup).
String	getShortName() Return a short description of the property.
ArrayList<AbstractProperty<?>>	getValue() Retrieve the current value of the property.
boolean	isReadOnly() Return true if the property can not be altered.
void	remove(int index) Remove a sub property from this CompoundProperty.
void	setValue(ArrayList<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.AbstractProperty

getDisplayPriority, iterator, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundProperty

public CompoundProperty(String shortName,
                String description,
                ArrayList<AbstractProperty<?>> initialValue,
                boolean readOnly,
                int displayPriority)

Construct an CompoundProperty.

Parameters:

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

Method Detail

getValue

public final ArrayList<AbstractProperty<?>> getValue()

Retrieve the current value of the property.

Specified by:

getValue in class AbstractProperty<ArrayList<AbstractProperty<?>>>

Returns:

T; the current value of the property

getShortName

public final String getShortName()

Return a short description of the property.

Specified by:

getShortName in class AbstractProperty<ArrayList<AbstractProperty<?>>>

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 class AbstractProperty<ArrayList<AbstractProperty<?>>>

Returns:

String; the description of the property

setValue

public final void setValue(ArrayList<AbstractProperty<?>> newValue)
                    throws PropertyException

Change the value of the property.

Specified by:

setValue in class AbstractProperty<ArrayList<AbstractProperty<?>>>

Parameters:

newValue - T; the new value for the property

Throws:

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

isReadOnly

public final boolean isReadOnly()

Return true if the property can not be altered.

Specified by:

isReadOnly in class AbstractProperty<ArrayList<AbstractProperty<?>>>

Returns:

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

findByShortName

public final AbstractProperty<?> findByShortName(String name)

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:

name - String; the name 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

size

public final int size()

Return the number of sub properties of this CompoundProperty.

Returns:

int; the number of sub properties of this CompoundProperty

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 ArrayList<AbstractProperty<?>> displayOrderedValue()

Return the sub-items in display order.

Returns:

ArrayList<AbstractProperty<?>>; the sub-items in display order