net.user1.union.api
Interface Message


public interface Message

A message is the unit of communication for clients, rooms and modules.


Method Summary
 java.lang.String getArg(java.lang.String name)
          Gets an argument in the message or null if no argument with the name given exists.
 java.util.Map<java.lang.String,java.lang.String> getArgs()
          Gets a map of all of the args in the message.
 java.lang.String getMessageName()
          Returns the name of the message.
 

Method Detail

getMessageName

java.lang.String getMessageName()
Returns the name of the message.

Returns:
the name of the message

getArg

java.lang.String getArg(java.lang.String name)
Gets an argument in the message or null if no argument with the name given exists.

Parameters:
name - - the name of the argument to return
Returns:
an argument in the message or null if no argument with the name exists

getArgs

java.util.Map<java.lang.String,java.lang.String> getArgs()
Gets a map of all of the args in the message.

Returns:
a map of all of the args in the message


Copyright USER1 Subsystems Corporation - Tue Jan 28 2014, 05:05 PM -0500