PaP
Class ApplicationMessage

java.lang.Object
  |
  +--PaP.ApplicationMessage

All Implemented Interfaces:

java.io.Serializable

public class ApplicationMessage

extends java.lang.Object

implements java.io.Serializable

This class defines the generic message interface between actors. Used in RoleSessionAction.

See Also:

Serialized Form

Field Summary

java.lang.String[]	message The set of message parameters that follows the message type
java.lang.String	messageType The message type identifier
java.lang.Object	objectMessage Used when the message is not a string.
java.lang.String	roleSessionId The role session the message is attached to

Constructor Summary

ApplicationMessage(java.lang.String pMessageType)
Create a new message instance with no parameters

ApplicationMessage(java.lang.String pMessageType, java.lang.String[] pMessage)
Create a new message instance with parameters

Method Summary

java.lang.String	toString() Simple utility to convert all data field values into one String for easy Debug purposes.
static java.lang.String	toString(ApplicationMessage obj) Simple utility to convert all data field values into one String for easy Debug purposes.
static boolean	validate(ApplicationMessage am, int npar) Validate number of parameters for the message

Methods inherited from class java.lang.Object

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

Field Detail

roleSessionId

public java.lang.String roleSessionId

The role session the message is attached to

messageType

public java.lang.String messageType

The message type identifier

message

public java.lang.String[] message

The set of message parameters that follows the message type

objectMessage

public java.lang.Object objectMessage

Used when the message is not a string.

Constructor Detail

ApplicationMessage

public ApplicationMessage(java.lang.String pMessageType,
                          java.lang.String[] pMessage)

Create a new message instance with parameters

Parameters:

pMessageType - The message type

pMessage - The set of parameters that follows the message

ApplicationMessage

public ApplicationMessage(java.lang.String pMessageType)

Create a new message instance with no parameters

Parameters:

pMessageType - The message type

Method Detail

toString

public java.lang.String toString()

Simple utility to convert all data field values into one String for easy Debug purposes.

Overrides:

toString in class java.lang.Object

Returns:

String form of the data field values

toString

public static java.lang.String toString(ApplicationMessage obj)

Simple utility to convert all data field values into one String for easy Debug purposes.

Returns:

String form of the data field values

validate

public static boolean validate(ApplicationMessage am,
                               int npar)

Validate number of parameters for the message

Parameters:

am - The application message to validate

npar - The number of parameters the message should contain

Returns:

true of validated ok, false else.