rescuecore2.registry

Class AbstractEntityFactory<T extends java.lang.Enum<T>>

java.lang.Object

rescuecore2.registry.AbstractEntityFactory<T>

Type Parameters:

T - An enum type that defines the URNs this factory knows about.

All Implemented Interfaces:

EntityFactory

Direct Known Subclasses:

StandardEntityFactory

public abstract class AbstractEntityFactory<T extends java.lang.Enum<T>>
extends java.lang.Object
implements EntityFactory

An abstract entity factory with helper methods for defining URNs with enums.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEntityFactory(java.lang.Class<T> clazz) Constructor for AbstractEntityFactory.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getKnownEntityURNs() Get all entity urns understood by this factory.
protected java.util.EnumSet<T>	getKnownEntityURNsEnum() Get an EnumSet containing known entity URNs.
Entity	makeEntity(java.lang.String urn, EntityID id) Create a new Entity.
protected abstract Entity	makeEntity(T urn, EntityID id) Create a new Entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEntityFactory

protected AbstractEntityFactory(java.lang.Class<T> clazz)

Constructor for AbstractEntityFactory.

Parameters:

clazz - The class of enum this factory uses.

Method Detail

getKnownEntityURNs

public java.lang.String[] getKnownEntityURNs()

Description copied from interface: EntityFactory

Get all entity urns understood by this factory.

Specified by:

getKnownEntityURNs in interface EntityFactory

Returns:

All entity urns.

makeEntity

public Entity makeEntity(java.lang.String urn,
                         EntityID id)

Description copied from interface: EntityFactory

Create a new Entity.

Specified by:

makeEntity in interface EntityFactory

Parameters:

urn - The urn of the entity to create.

id - The id of the new entity.

Returns:

A new Entity of the correct type.

getKnownEntityURNsEnum

protected java.util.EnumSet<T> getKnownEntityURNsEnum()

Get an EnumSet containing known entity URNs. Default implementation returns EnumSet.allOf(T).

Returns:

An EnumSet containing known entity URNs.

makeEntity

protected abstract Entity makeEntity(T urn,
                                     EntityID id)

Create a new Entity.

Parameters:

urn - The enum urn of the entity to create.

id - The id of the new entity.

Returns:

A new Entity of the correct type.

Throws:

java.lang.IllegalArgumentException - If the urn is not recognised.