rescuecore2.worldmodel.properties

Class BooleanProperty

java.lang.Object

rescuecore2.worldmodel.AbstractProperty

rescuecore2.worldmodel.properties.BooleanProperty

All Implemented Interfaces:

Property

public class BooleanProperty
extends AbstractProperty

A boolean property.

Constructor Summary

Constructors

Constructor and Description
BooleanProperty(BooleanProperty other) BooleanProperty copy constructor.
BooleanProperty(java.lang.Enum<?> urn) Construct a BooleanProperty with no defined value.
BooleanProperty(java.lang.Enum<?> urn, boolean value) Construct a BooleanProperty with a defined value.
BooleanProperty(java.lang.String urn) Construct a BooleanProperty with no defined value.
BooleanProperty(java.lang.String urn, boolean value) Construct a BooleanProperty with a defined value.

Method Summary

Modifier and Type	Method and Description
BooleanProperty	copy() Create a copy of this property.
java.lang.Boolean	getValue() Get the value of this property.
void	read(java.io.InputStream in) Read this property from a stream.
void	setValue(boolean value) Set the value of this property.
void	takeValue(Property p) Take on the value of another property.
void	write(java.io.OutputStream out) Write this property to a stream.

Methods inherited from class rescuecore2.worldmodel.AbstractProperty

fireChange, getURN, isDefined, setDefined, setEntity, toString, undefine

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanProperty

public BooleanProperty(java.lang.String urn)

Construct a BooleanProperty with no defined value.

Parameters:

urn - The urn of this property.

BooleanProperty

public BooleanProperty(java.lang.Enum<?> urn)

Construct a BooleanProperty with no defined value.

Parameters:

urn - The urn of this property.

BooleanProperty

public BooleanProperty(java.lang.String urn,
                       boolean value)

Construct a BooleanProperty with a defined value.

Parameters:

urn - The urn of this property.

value - The initial value of the property.

BooleanProperty

public BooleanProperty(java.lang.Enum<?> urn,
                       boolean value)

Construct a BooleanProperty with a defined value.

Parameters:

urn - The urn of this property.

value - The initial value of the property.

BooleanProperty

public BooleanProperty(BooleanProperty other)

BooleanProperty copy constructor.

Parameters:

other - The BooleanProperty to copy.

Method Detail

getValue

public java.lang.Boolean getValue()

Description copied from interface: Property

Get the value of this property. If the property is undefined then the return value should be null.

Returns:

The value of this property.

setValue

public void setValue(boolean value)

Set the value of this property. Future calls to AbstractProperty.isDefined() will return true.

Parameters:

value - The new value.

takeValue

public void takeValue(Property p)

Description copied from interface: Property

Take on the value of another property.

Parameters:

p - The other property to inspect.

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Description copied from interface: Property

Write this property to a stream.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - If the write fails.

read

public void read(java.io.InputStream in)
          throws java.io.IOException

Description copied from interface: Property

Read this property from a stream.

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If the read fails.

copy

public BooleanProperty copy()

Description copied from interface: Property

Create a copy of this property.

Returns:

A copy of this property.