rescuecore2.worldmodel

Interface Entity

All Known Implementing Classes:

AbstractEntity, AmbulanceCentre, AmbulanceTeam, Area, Blockade, Building, Civilian, FireBrigade, FireStation, GasStation, Human, Hydrant, PoliceForce, PoliceOffice, Refuge, Road, StandardEntity, World

public interface Entity

Interface for all objects that live in a WorldModel. Entities are made up of a fixed set of properties. The values of those properties may change but the set of properties may not.

Method Summary

Modifier and Type	Method and Description
void	addEntityListener(EntityListener l) Add an EntityListener.
Entity	copy() Create a copy of this entity.
EntityID	getID() Get the ID of this Entity.
java.util.Set<Property>	getProperties() Get all the properties that this entity has.
Property	getProperty(java.lang.String urn) Get a property by urn.
java.lang.String	getURN() Get the urn of this Entity.
void	read(java.io.InputStream in) Read this Entity from a stream.
void	removeEntityListener(EntityListener l) Remove an EntityListener.
void	write(java.io.OutputStream out) Write this Entity to a stream.

Method Detail

addEntityListener

void addEntityListener(EntityListener l)

Add an EntityListener.

Parameters:

l - The listener to add.

removeEntityListener

void removeEntityListener(EntityListener l)

Remove an EntityListener.

Parameters:

l - The listener to remove.

getID

EntityID getID()

Get the ID of this Entity.

Returns:

The ID.

getURN

java.lang.String getURN()

Get the urn of this Entity.

Returns:

The type.

getProperties

java.util.Set<Property> getProperties()

Get all the properties that this entity has.

Returns:

A set of Properties. This will never be null, but may be empty.

getProperty

Property getProperty(java.lang.String urn)

Get a property by urn.

Parameters:

urn - The urn to look up.

Returns:

The property with the given urn or null if no such property exists.

write

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

Write this Entity 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 Entity from a stream.

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If the read fails.

copy

Entity copy()

Create a copy of this entity.

Returns:

A new Entity with the same ID and property values.