rescuecore2.standard.entities

Class EdgeListProperty

java.lang.Object

rescuecore2.worldmodel.AbstractProperty

rescuecore2.standard.entities.EdgeListProperty

All Implemented Interfaces:

Property

public class EdgeListProperty
extends AbstractProperty

A property that defines a list of Edges.

Constructor Summary

Constructors

Constructor and Description
EdgeListProperty(EdgeListProperty other) EdgeListProperty copy constructor.
EdgeListProperty(java.lang.Enum<?> urn) Construct a new EdgeListProperty with no defined value.
EdgeListProperty(java.lang.Enum<?> urn, java.util.List<Edge> edges) Construct a new EdgeListProperty with no defined value.
EdgeListProperty(java.lang.String urn) Construct a new EdgeListProperty with no defined value.
EdgeListProperty(java.lang.String urn, java.util.List<Edge> edges) Construct a new EdgeListProperty with no defined value.

Method Summary

Modifier and Type	Method and Description
void	addEdge(Edge edge) Add an edge to the list.
void	clearEdges() Remove all edges from this list but keep it defined.
EdgeListProperty	copy() Create a copy of this property.
java.util.List<Edge>	getValue() Get the value of this property.
void	read(java.io.InputStream in) Read this property from a stream.
void	setEdges(java.util.List<Edge> newEdges) Set the list of edges.
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

EdgeListProperty

public EdgeListProperty(java.lang.String urn)

Construct a new EdgeListProperty with no defined value.

Parameters:

urn - The urn of this property.

EdgeListProperty

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

Construct a new EdgeListProperty with no defined value.

Parameters:

urn - The urn of this property.

EdgeListProperty

public EdgeListProperty(java.lang.String urn,
                        java.util.List<Edge> edges)

Construct a new EdgeListProperty with no defined value.

Parameters:

urn - The urn of this property.

edges - The edge list.

EdgeListProperty

public EdgeListProperty(java.lang.Enum<?> urn,
                        java.util.List<Edge> edges)

Construct a new EdgeListProperty with no defined value.

Parameters:

urn - The urn of this property.

edges - The edge list.

EdgeListProperty

public EdgeListProperty(EdgeListProperty other)

EdgeListProperty copy constructor.

Parameters:

other - The EdgeListProperty to copy.

Method Detail

getValue

public java.util.List<Edge> 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.

setEdges

public void setEdges(java.util.List<Edge> newEdges)

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

Parameters:

newEdges - The new edge list.

addEdge

public void addEdge(Edge edge)

Add an edge to the list.

Parameters:

edge - The edge to add.

clearEdges

public void clearEdges()

Remove all edges 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 EdgeListProperty copy()

Description copied from interface: Property

Create a copy of this property.

Returns:

A copy of this property.