rescuecore2.worldmodel.properties

Class EntityRefListProperty

java.lang.Object

rescuecore2.worldmodel.AbstractProperty

rescuecore2.worldmodel.properties.EntityRefListProperty

All Implemented Interfaces:

Property

public class EntityRefListProperty
extends AbstractProperty

A property that refers to a list of entity IDs.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addValue(EntityID id) Add a value to the list.
void	clearValues() Remove all entries from this list but keep it defined.
EntityRefListProperty	copy() Create a copy of this property.
java.util.List<EntityID>	getValue() Get the value of this property.
void	read(java.io.InputStream in) Read this property from a stream.
void	setValue(java.util.List<EntityID> newIDs) Set the list of ids.
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

EntityRefListProperty

public EntityRefListProperty(java.lang.String urn)

Construct an EntityRefListProperty with no defined value.

Parameters:

urn - The urn of this property.

EntityRefListProperty

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

Construct an EntityRefListProperty with no defined value.

Parameters:

urn - The urn of this property.

EntityRefListProperty

public EntityRefListProperty(java.lang.String urn,
                             java.util.List<EntityID> ids)

Construct an EntityRefListProperty with a defined value.

Parameters:

urn - The urn of this property.

ids - The initial value of the property.

EntityRefListProperty

public EntityRefListProperty(java.lang.Enum<?> urn,
                             java.util.List<EntityID> ids)

Construct an EntityRefListProperty with a defined value.

Parameters:

urn - The urn of this property.

ids - The initial value of the property.

EntityRefListProperty

public EntityRefListProperty(EntityRefListProperty other)

EntityRefListProperty copy constructor.

Parameters:

other - The EntityRefListProperty to copy.

Method Detail

getValue

public java.util.List<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(java.util.List<EntityID> newIDs)

Set the list of ids. Future calls to AbstractProperty.isDefined() will return true.

Parameters:

newIDs - The new id list.

addValue

public void addValue(EntityID id)

Add a value to the list.

Parameters:

id - The id to add.

clearValues

public void clearValues()

Remove all entries from this list but keep it defined.

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 EntityRefListProperty copy()

Description copied from interface: Property

Create a copy of this property.

Returns:

A copy of this property.