rescuecore2.registry

Class Registry

java.lang.Object

rescuecore2.registry.Registry

public final class Registry
extends java.lang.Object

A class for managing the different types of entities, properties, messages and their associated factories.

Field Summary

Fields

Modifier and Type	Field and Description
static Registry	SYSTEM_REGISTRY The system-(or at least Classloader)-wide Registry.

Constructor Summary

Constructors

Constructor and Description
Registry() Create a new Registry that uses the system registry as a parent.
Registry(Registry parent) Create a new Registry with a particular parent.
Registry(java.lang.String name) Create a new Registry with a particular name that uses the system registry as a parent.
Registry(java.lang.String name, Registry parent) Create a new Registry with a particular name and parent.

Method Summary

Modifier and Type	Method and Description
Entity	createEntity(java.lang.String urn, EntityID id) Create an entity from a urn.
Message	createMessage(java.lang.String urn, java.io.InputStream data) Create a message from a urn.
Property	createProperty(java.lang.String urn) Create a property from a urn.
static Registry	getCurrentRegistry() Get the current Registry for this thread.
protected EntityFactory	getEntityFactory(java.lang.String urn) Get the entity factory for a URN, delegating to the parent if required.
protected MessageFactory	getMessageFactory(java.lang.String urn) Get the message factory for a URN, delegating to the parent if required.
java.lang.String	getName() Get the name of this registry.
protected PropertyFactory	getPropertyFactory(java.lang.String urn) Get the property factory for a URN, delegating to the parent if required.
void	registerEntityFactory(EntityFactory factory) Register an entity factory.
void	registerEntityFactory(java.lang.String urn, EntityFactory factory) Register an entity URN and assign an EntityFactory for constructing instances of this type.
void	registerMessageFactory(MessageFactory factory) Register a message factory.
void	registerMessageFactory(java.lang.String urn, MessageFactory factory) Register a message URN and assign a MessageFactory for constructing instances of this type.
void	registerPropertyFactory(PropertyFactory factory) Register a property factory.
void	registerPropertyFactory(java.lang.String urn, PropertyFactory factory) Register a property URN and assign a PropertyFactory for constructing instances of this type.
static void	setCurrentRegistry(Registry r) Set the current Registry for this thread.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_REGISTRY

public static final Registry SYSTEM_REGISTRY

The system-(or at least Classloader)-wide Registry.

Constructor Detail

Registry

public Registry()

Create a new Registry that uses the system registry as a parent.

Registry

public Registry(java.lang.String name)

Create a new Registry with a particular name that uses the system registry as a parent.

Parameters:

name - The name of this Registry.

Registry

public Registry(Registry parent)

Create a new Registry with a particular parent.

Parameters:

parent - The parent Registry.

Registry

public Registry(java.lang.String name,
                Registry parent)

Create a new Registry with a particular name and parent.

Parameters:

name - The name of this Registry.

parent - The parent Registry.

Method Detail

getCurrentRegistry

public static Registry getCurrentRegistry()

Get the current Registry for this thread.

Returns:

The current Registry for this thread.

setCurrentRegistry

public static void setCurrentRegistry(Registry r)

Set the current Registry for this thread.

Parameters:

r - The current Registry for this thread.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Get the name of this registry.

Returns:

The name of this registry.

registerEntityFactory

public void registerEntityFactory(EntityFactory factory)

Register an entity factory. This will register all entity URNs that the factory knows about.

Parameters:

factory - The entity factory to register.

registerEntityFactory

public void registerEntityFactory(java.lang.String urn,
                                  EntityFactory factory)

Register an entity URN and assign an EntityFactory for constructing instances of this type.

Parameters:

urn - The urn to register.

factory - The factory that is responsible for constructing entity instances of this type.

registerPropertyFactory

public void registerPropertyFactory(PropertyFactory factory)

Register a property factory. This will register all property URNs that the factory knows about.

Parameters:

factory - The property factory to register.

registerPropertyFactory

public void registerPropertyFactory(java.lang.String urn,
                                    PropertyFactory factory)

Register a property URN and assign a PropertyFactory for constructing instances of this type.

Parameters:

urn - The urn to register.

factory - The factory that is responsible for constructing property instances of this type.

registerMessageFactory

public void registerMessageFactory(MessageFactory factory)

Register a message factory. This will register all message URNs that the factory knows about.

Parameters:

factory - The message factory to register.

registerMessageFactory

public void registerMessageFactory(java.lang.String urn,
                                   MessageFactory factory)

Register a message URN and assign a MessageFactory for constructing instances of this type.

Parameters:

urn - The urn to register.

factory - The factory that is responsible for constructing message instances of this type.

createEntity

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

Create an entity from a urn. If the urn is not recognised then return null. This method will delegate to the previously registered EntityFactory.

Parameters:

urn - The urn of the entity type to create.

id - The EntityID of the Entity that will be created.

Returns:

A new Entity object, or null if the urn is not recognised.

createProperty

public Property createProperty(java.lang.String urn)

Create a property from a urn. If the urn is not recognised then return null. This method will delegate to the previously registered PropertyFactory.

Parameters:

urn - The urn of the property type to create.

Returns:

A new Property object, or null if the urn is not recognised.

createMessage

public Message createMessage(java.lang.String urn,
                             java.io.InputStream data)
                      throws java.io.IOException

Create a message from a urn. If the urn is not recognised then return null. This method will delegate to the previously registered MessageFactory.

Parameters:

urn - The urn of the message type to create.

data - An InputStream to read message data from.

Returns:

A new Message object, or null if the urn is not recognised.

Throws:

java.io.IOException - If there is a problem decoding the message.

getEntityFactory

protected EntityFactory getEntityFactory(java.lang.String urn)

Get the entity factory for a URN, delegating to the parent if required.

Parameters:

urn - The URN to look up.

Returns:

An EntityFactory, or null if the URN is not recognised.

getPropertyFactory

protected PropertyFactory getPropertyFactory(java.lang.String urn)

Get the property factory for a URN, delegating to the parent if required.

Parameters:

urn - The URN to look up.

Returns:

A PropertyFactory, or null if the URN is not recognised.

getMessageFactory

protected MessageFactory getMessageFactory(java.lang.String urn)

Get the message factory for a URN, delegating to the parent if required.

Parameters:

urn - The URN to look up.

Returns:

A MessageFactory, or null if the URN is not recognised.