rescuecore2.registry

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

java.lang.Object

rescuecore2.registry.AbstractMessageFactory<T>

Type Parameters:

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

All Implemented Interfaces:

MessageFactory

Direct Known Subclasses:

ControlMessageFactory, StandardMessageFactory

public abstract class AbstractMessageFactory<T extends java.lang.Enum<T>>
extends java.lang.Object
implements MessageFactory

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getKnownMessageURNs() Get all message urns understood by this factory.
protected java.util.EnumSet<T>	getKnownMessageURNsEnum() Get an EnumSet containing known message URNs.
Message	makeMessage(java.lang.String urn, java.io.InputStream data) Create a message based on its urn and populate it with data from a stream.
protected abstract Message	makeMessage(T urn, java.io.InputStream data) Create a message based on its urn and populate it with data from a stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMessageFactory

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

Constructor for AbstractMessageFactory.

Parameters:

clazz - The class of enum this factory uses.

Method Detail

getKnownMessageURNs

public java.lang.String[] getKnownMessageURNs()

Description copied from interface: MessageFactory

Get all message urns understood by this factory.

Specified by:

getKnownMessageURNs in interface MessageFactory

Returns:

All message urns.

makeMessage

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

Description copied from interface: MessageFactory

Create a message based on its urn and populate it with data from a stream. If the urn is not recognised then return null.

Specified by:

makeMessage in interface 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 reading the stream.

getKnownMessageURNsEnum

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

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

Returns:

An EnumSet containing known message URNs.

makeMessage

protected abstract Message makeMessage(T urn,
                                       java.io.InputStream data)
                                throws java.io.IOException

Create a message based on its urn and populate it with data from a stream. If the urn is not recognised then return null.

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 reading the stream.