rescuecore2.worldmodel

Class AbstractEntity

java.lang.Object

rescuecore2.worldmodel.AbstractEntity

All Implemented Interfaces:

Entity

Direct Known Subclasses:

StandardEntity

public abstract class AbstractEntity
extends java.lang.Object
implements Entity

Abstract base class for concrete Entity implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEntity(AbstractEntity other) AbstractEntity copy constructor.
protected	AbstractEntity(EntityID id) Construct an AbstractEntity with a set of properties.

Method Summary

Modifier and Type	Method and Description
void	addEntityListener(EntityListener l) Add an EntityListener.
Entity	copy() Create a copy of this entity.
protected abstract Entity	copyImpl() Create a copy of this entity.
boolean	equals(java.lang.Object o)
protected void	firePropertyChanged(Property p, java.lang.Object oldValue, java.lang.Object newValue) Notify all listeners that a property has changed.
protected java.lang.String	getEntityName() Get the name of this entity.
java.lang.String	getFullDescription() Get the full description of this object.
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 propertyURN) Get a property by urn.
int	hashCode()
void	read(java.io.InputStream in) Read this Entity from a stream.
protected void	registerProperties(Property... props) Register a set of properties.
void	removeEntityListener(EntityListener l) Remove an EntityListener.
java.lang.String	toString()
void	write(java.io.OutputStream out) Write this Entity to a stream.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface rescuecore2.worldmodel.Entity

getURN

Constructor Detail

AbstractEntity

protected AbstractEntity(EntityID id)

Construct an AbstractEntity with a set of properties.

Parameters:

id - The ID of this entity.

AbstractEntity

protected AbstractEntity(AbstractEntity other)

AbstractEntity copy constructor.

Parameters:

other - The AbstractEntity to copy.

Method Detail

addEntityListener

public void addEntityListener(EntityListener l)

Description copied from interface: Entity

Add an EntityListener.

Specified by:

addEntityListener in interface Entity

Parameters:

l - The listener to add.

removeEntityListener

public void removeEntityListener(EntityListener l)

Description copied from interface: Entity

Remove an EntityListener.

Specified by:

removeEntityListener in interface Entity

Parameters:

l - The listener to remove.

copy

public Entity copy()

Description copied from interface: Entity

Create a copy of this entity.

Specified by:

copy in interface Entity

Returns:

A new Entity with the same ID and property values.

copyImpl

protected abstract Entity copyImpl()

Create a copy of this entity. Property values do not need to be copied.

Returns:

A new Entity of the same type as this and with the same ID.

getProperties

public final java.util.Set<Property> getProperties()

Description copied from interface: Entity

Get all the properties that this entity has.

Specified by:

getProperties in interface Entity

Returns:

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

getProperty

public Property getProperty(java.lang.String propertyURN)

Description copied from interface: Entity

Get a property by urn.

Specified by:

getProperty in interface Entity

Parameters:

propertyURN - The urn to look up.

Returns:

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

getID

public EntityID getID()

Description copied from interface: Entity

Get the ID of this Entity.

Specified by:

getID in interface Entity

Returns:

The ID.

write

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

Description copied from interface: Entity

Write this Entity to a stream.

Specified by:

write in interface Entity

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: Entity

Read this Entity from a stream.

Specified by:

read in interface Entity

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If the read fails.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFullDescription

public java.lang.String getFullDescription()

Get the full description of this object.

Returns:

The full description.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

getEntityName

protected java.lang.String getEntityName()

Get the name of this entity. Default implementation returns the entity URN.

Returns:

The name of this entity.

registerProperties

protected void registerProperties(Property... props)

Register a set of properties.

Parameters:

props - The properties to register.

firePropertyChanged

protected void firePropertyChanged(Property p,
                                   java.lang.Object oldValue,
                                   java.lang.Object newValue)

Notify all listeners that a property has changed.

Parameters:

p - The changed property.

oldValue - The old value.

newValue - The new value.