BooleanProperty (Open Traffic Sim core classes 0.03.01 API)

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

All Implemented Interfaces:

Iterable<AbstractProperty<Boolean>>
```
public class BooleanProperty
extends AbstractProperty<Boolean>
```
Boolean 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 29 dec. 2014

Author:

Peter Knoppers

Constructor Summary

Constructors
Constructor and Description
`BooleanProperty(String shortName, String description, Boolean initialValue, boolean readOnly, int displayPriority)` Construct an BooleanProperty.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractProperty<Boolean>`	`deepCopy()` Construct a deep copy of this property (duplicates everything except immutable fields).
`String`	`getDescription()` Return a description of the property (may use HTML markup).
`String`	`getShortName()` Return a short description of the property.
`Boolean`	`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(Boolean newValue)` Change the value of the property.

Methods inherited from class org.opentrafficsim.simulationengine.properties.AbstractProperty
getDisplayPriority, iterator, 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
  - BooleanProperty
```
public BooleanProperty(String shortName,
                       String description,
                       Boolean initialValue,
                       boolean readOnly,
                       int displayPriority)
```
    Construct an BooleanProperty.
    
    Parameters:
    
    shortName - String; the short name of the new BooleanProperty
    
    description - String; description of the new BooleanProperty (may use HTML mark up)
    
    initialValue - Integer; the initial value of the new BooleanProperty
    
    readOnly - boolean; if true this BooleanProperty can not be altered
    
    displayPriority - int; the displayPriority of the new BooleanProperty
- Method Detail
  - getValue
```
public final Boolean getValue()
```
    Retrieve the current value of the property.
    
    Specified by:
    
    getValue in class AbstractProperty<Boolean>
    
    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<Boolean>
    
    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<Boolean>
    
    Returns:
    
    String; the description of the property
  - setValue
```
public final void setValue(Boolean newValue)
                    throws PropertyException
```
    Change the value of the property.
    
    Specified by:
    
    setValue in class AbstractProperty<Boolean>
    
    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<Boolean>
    
    Returns:
    
    boolean; true if this property can not be altered, false if this property can be altered
  - 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 class AbstractProperty<Boolean>
    
    Returns:
    
    String; the description of this property and the current state in HTML
  - deepCopy
```
public AbstractProperty<Boolean> deepCopy()
```
    Construct a deep copy of this property (duplicates everything except immutable fields).
    
    Specified by:
    
    deepCopy in class AbstractProperty<Boolean>
    
    Returns:
    
    AbstractProperty<T>; a deep copy of this AbstractProperty

Class BooleanProperty

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

BooleanProperty

Method Detail

getValue

getShortName

getDescription

setValue

isReadOnly

htmlStateDescription

deepCopy