rescuecore2.worldmodel

Interface Property

All Known Implementing Classes:

AbstractProperty, BooleanProperty, DoubleProperty, EdgeListProperty, EntityRefListProperty, EntityRefProperty, IntArrayProperty, IntProperty, Point2DProperty

public interface Property

Interface for the properties that make up an entity.

Method Summary

Modifier and Type	Method and Description
Property	copy() Create a copy of this property.
java.lang.String	getURN() Get the urn of this property.
java.lang.Object	getValue() Get the value of this property.
boolean	isDefined() Does this property have a defined value?
void	read(java.io.InputStream in) Read this property from a stream.
void	takeValue(Property other) Take on the value of another property.
void	undefine() Undefine the value of this property.
void	write(java.io.OutputStream out) Write this property to a stream.

Method Detail

getURN

java.lang.String getURN()

Get the urn of this property.

Returns:

The urn of this property.

isDefined

boolean isDefined()

Does this property have a defined value?

Returns:

True if a value has been set for this property, false otherwise.

undefine

void undefine()

Undefine the value of this property. Future calls to isDefined() will return false.

takeValue

void takeValue(Property other)

Take on the value of another property.

Parameters:

other - The other property to inspect.

Throws:

java.lang.IllegalArgumentException - If the other property is the wrong type.

write

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

Write this property to a stream.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - If the write fails.

read

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

Read this property from a stream.

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If the read fails.

getValue

java.lang.Object getValue()

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

Returns:

The value of this property.

copy

Property copy()

Create a copy of this property.

Returns:

A copy of this property.