rescuecore2.messages

Class AbstractMessage

java.lang.Object

rescuecore2.messages.AbstractMessage

All Implemented Interfaces:

Message

Direct Known Subclasses:

AbstractCommand, AKAcknowledge, AKConnect, EntityIDRequest, EntityIDResponse, GKConnectError, GKConnectOK, KAConnectError, KAConnectOK, KASense, KGAcknowledge, KGConnect, KSAfterShocksInfo, KSCommands, KSConnectError, KSConnectOK, KSUpdate, KVConnectError, KVConnectOK, KVTimestep, Shutdown, SKAcknowledge, SKConnect, SKUpdate, VKAcknowledge, VKConnect

public abstract class AbstractMessage
extends java.lang.Object
implements Message

An abstract base class for Message objects. This class is implemented in terms of MessageComponent objects so subclasses need only provide a urn and a list of MessageComponent objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMessage(java.lang.Enum<?> urn) Construct a message with a urn defined as an enum.
protected	AbstractMessage(java.lang.String urn) Construct a message with a given urn.

Method Summary

Modifier and Type	Method and Description
protected void	addMessageComponent(MessageComponent component) Add a message component.
java.util.List<MessageComponent>	getComponents() Get all the components of this message.
java.lang.String	getURN() Get the urn of this message type.
void	read(java.io.InputStream in) Read the content of this message from a stream.
java.lang.String	toString()
void	write(java.io.OutputStream out) Write the content of this message to a stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMessage

protected AbstractMessage(java.lang.String urn)

Construct a message with a given urn.

Parameters:

urn - The urn of the message.

AbstractMessage

protected AbstractMessage(java.lang.Enum<?> urn)

Construct a message with a urn defined as an enum.

Parameters:

urn - The urn of the message.

Method Detail

getURN

public final java.lang.String getURN()

Description copied from interface: Message

Get the urn of this message type.

Specified by:

getURN in interface Message

Returns:

The message urn.

getComponents

public final java.util.List<MessageComponent> getComponents()

Get all the components of this message.

Returns:

A List of MessageComponent objects.

addMessageComponent

protected void addMessageComponent(MessageComponent component)

Add a message component.

Parameters:

component - The component to add.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Description copied from interface: Message

Write the content of this message to a stream. The content should not include the message type ID.

Specified by:

write in interface Message

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - If the write fails.

read

public void read(java.io.InputStream in)
          throws java.io.IOException

Description copied from interface: Message

Read the content of this message from a stream. The content should not include the message type ID.

Specified by:

read in interface Message

Parameters:

in - The stream to read from.

Throws:

java.io.IOException - If the read fails.