rescuecore2.worldmodel

Interface WorldModel<T extends Entity>

Type Parameters:

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

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

AbstractWorldModel, CollapseWorldModel, DefaultWorldModel, StandardWorldModel

public interface WorldModel<T extends Entity>
extends java.lang.Iterable<T>

This class encapsulates everything about a world model. The world model can be parameterised on a subclass of Entity if required.

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.
void	addWorldModelListener(WorldModelListener<? super T> l) Add a listener for world model events.
java.util.Collection<T>	getAllEntities() Get all entities in the world.
T	getEntity(EntityID id) Look up an entity by ID.
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.
void	removeAllEntities() Remove all entities from the world.
void	removeEntity(EntityID id) Remove an entity from the world.
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 interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

addWorldModelListener

void addWorldModelListener(WorldModelListener<? super T> l)

Add a listener for world model events.

Parameters:

l - The listener to add.

removeWorldModelListener

void removeWorldModelListener(WorldModelListener<? super T> l)

Remove a listener for world model events.

Parameters:

l - The listener to remove.

getAllEntities

java.util.Collection<T> getAllEntities()

Get all entities in the world.

Returns:

An immutable view of all entities in the world.

addEntity

void addEntity(Entity e)

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

Parameters:

e - The entity to add.

addEntities

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

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

Parameters:

e - The entities to add.

removeEntity

void removeEntity(T e)

Remove an entity from the world.

Parameters:

e - The entity to remove.

removeEntity

void removeEntity(EntityID id)

Remove an entity from the world.

Parameters:

id - The entityID to remove.

removeAllEntities

void removeAllEntities()

Remove all entities from the world.

getEntity

T getEntity(EntityID id)

Look up an entity by ID.

Parameters:

id - The EntityID to look up.

Returns:

The entity with the given ID, or null if no such entity exists.

merge

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

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.

Parameters:

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

merge

void merge(ChangeSet changeSet)

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 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.

Parameters:

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