rescuecore2.worldmodel

Class AbstractWorldModel<T extends Entity>

java.lang.Object

rescuecore2.worldmodel.AbstractWorldModel<T>

Type Parameters:

T - The subclass of Entity that this world model holds.

All Implemented Interfaces:

java.lang.Iterable<T>, WorldModel<T>

Direct Known Subclasses:

DefaultWorldModel

public abstract class AbstractWorldModel<T extends Entity>
extends java.lang.Object
implements WorldModel<T>

Abstract base class for WorldModel implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWorldModel() Construct a new abstract world model.

Method Summary

Modifier and Type	Method and Description
void	addEntities(java.util.Collection<? extends Entity> e) Add a set of entities to the world.
void	addEntity(Entity e) Add an entity to the world.
protected abstract void	addEntityImpl(T t) Subclasses should provide their implementation of addEntity here.
void	addWorldModelListener(WorldModelListener<? super T> l) Add a listener for world model events.
protected void	fireEntityAdded(T e) Notify listeners that an entity has been added.
protected void	fireEntityRemoved(T e) Notify listeners that an entity has been removed.
protected boolean	isAllowed(Entity e) Find out if a particular Entity is allowed into this world model.
void	merge(ChangeSet changeSet) Merge a set of changes into this world.
void	merge(java.util.Collection<? extends Entity> toMerge) Merge a set of entities into this world.
protected void	registerAllowedClass(java.lang.Class<? extends T> clazz) Register an allowed class.
void	removeEntity(T e) Remove an entity from the world.
void	removeWorldModelListener(WorldModelListener<? super T> l) Remove a listener for world model events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface rescuecore2.worldmodel.WorldModel

getAllEntities, getEntity, removeAllEntities, removeEntity

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

AbstractWorldModel

protected AbstractWorldModel()

Construct a new abstract world model.

Method Detail

addWorldModelListener

public final void addWorldModelListener(WorldModelListener<? super T> l)

Description copied from interface: WorldModel

Add a listener for world model events.

Specified by:

addWorldModelListener in interface WorldModel<T extends Entity>

Parameters:

l - The listener to add.

removeWorldModelListener

public final void removeWorldModelListener(WorldModelListener<? super T> l)

Description copied from interface: WorldModel

Remove a listener for world model events.

Specified by:

removeWorldModelListener in interface WorldModel<T extends Entity>

Parameters:

l - The listener to remove.

addEntity

public final void addEntity(Entity e)

Description copied from interface: WorldModel

Add an entity to the world. Note that this method is not parameterised by T.

Specified by:

addEntity in interface WorldModel<T extends Entity>

Parameters:

e - The entity to add.

addEntities

public final void addEntities(java.util.Collection<? extends Entity> e)

Description copied from interface: WorldModel

Add a set of entities to the world. Note that this method is not parameterised by T.

Specified by:

addEntities in interface WorldModel<T extends Entity>

Parameters:

e - The entities to add.

removeEntity

public final void removeEntity(T e)

Description copied from interface: WorldModel

Remove an entity from the world.

Specified by:

removeEntity in interface WorldModel<T extends Entity>

Parameters:

e - The entity to remove.

addEntityImpl

protected abstract void addEntityImpl(T t)

Subclasses should provide their implementation of addEntity here.

Parameters:

t - The entity to add.

merge

public void merge(java.util.Collection<? extends Entity> toMerge)

Description copied from interface: WorldModel

Merge a set of entities into this world. New entities will be added; existing entities will have properties replaced with those taken from the given objects. Any undefined properties in the given objects will NOT cause existing properties to become undefined. Note that this method is not parameterised by T.

Specified by:

merge in interface WorldModel<T extends Entity>

Parameters:

toMerge - The set of entities to merge into this world model.

merge

public void merge(ChangeSet changeSet)

Description copied from interface: WorldModel

Merge a set of changes into this world. If the ChangeSet specifies that a property has become undefined then the existing property WILL become undefined. This behaviour is different to the WorldModel.merge(Collection) method because an undefined value inside a ChangeSet means that the property value has become undefined, whereas in the other version of merge an undefined property means there is no value for that property.

Specified by:

merge in interface WorldModel<T extends Entity>

Parameters:

changeSet - The set of changes to merge into this world model.

fireEntityAdded

protected final void fireEntityAdded(T e)

Notify listeners that an entity has been added.

Parameters:

e - The new entity.

fireEntityRemoved

protected final void fireEntityRemoved(T e)

Notify listeners that an entity has been removed.

Parameters:

e - The entity that has been removed.

isAllowed

protected boolean isAllowed(Entity e)

Find out if a particular Entity is allowed into this world model. The default implementation checks that the object is assignable to at least one class previously registered with registerAllowedClass(Class).

Parameters:

e - The entity to check.

Returns:

True if the entity is allowed, false otherwise.

registerAllowedClass

protected void registerAllowedClass(java.lang.Class<? extends T> clazz)

Register an allowed class.

Parameters:

clazz - The subclass of Entity that is allowed in this world model.