rescuecore2.worldmodel.properties

Class EntityRefProperty

java.lang.Object

rescuecore2.worldmodel.AbstractProperty

rescuecore2.worldmodel.properties.EntityRefProperty

All Implemented Interfaces:

Property

public class EntityRefProperty
extends AbstractProperty

A property that refers to an entity ID.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EntityRefProperty	copy() Create a copy of this property.
EntityID	getValue() Get the value of this property.
void	read(java.io.InputStream in) Read this property from a stream.
void	setValue(EntityID 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

EntityRefProperty

public EntityRefProperty(java.lang.String urn)

Construct an EntityRefProperty with no defined value.

Parameters:

urn - The urn of this property.

EntityRefProperty

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

Construct an EntityRefProperty with no defined value.

Parameters:

urn - The urn of this property.

EntityRefProperty

public EntityRefProperty(java.lang.String urn,
                         EntityID value)

Construct an EntityRefProperty with a defined value.

Parameters:

urn - The urn of this property.

value - The initial value of the property.

EntityRefProperty

public EntityRefProperty(java.lang.Enum<?> urn,
                         EntityID value)

Construct an EntityRefProperty with a defined value.

Parameters:

urn - The urn of this property.

value - The initial value of the property.

EntityRefProperty

public EntityRefProperty(EntityRefProperty other)

EntityRefProperty copy constructor.

Parameters:

other - The EntityRefProperty to copy.

Method Detail

getValue

public EntityID 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(EntityID 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 EntityRefProperty copy()

Description copied from interface: Property

Create a copy of this property.

Returns:

A copy of this property.