vscript.message
Class Message

java.lang.Object
  |
  +--vscript.message.Message

public class Message
extends java.lang.Object

The message object represents the message passed between messagable components. For handline messages users have to use the getMessageString() and getArguments() methods of message object.


Constructor Summary
Message(java.util.LinkedList destination, java.lang.String message, java.lang.String[] argStr)
           
 
Method Summary
 java.lang.String constructMessage()
           
 java.lang.String[] getArguments()
          Get the arguments in the message.
 java.util.LinkedList getDestination()
          Returns the destination of the message.
 java.lang.String getMessageString()
          Returns the name of the message.
 java.lang.String getNextDestination(boolean adjust)
           
 int getNextDestIndex()
           
 vscript.message.MessageNode getSourceMessageNode()
          Returns the source message node of this message.
 void prepareMessage(vscript.message.MessageNode node)
          Prepare message prepares the message by filling in the values for all place holders.
 void removeNextDestination()
           
 void resetDestination()
           
 void setNextDestIndex(int index)
           
 void setSourceMessageNode(vscript.message.MessageNode node)
          Sets the sourceMessageNode of this message.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Message

public Message(java.util.LinkedList destination,
               java.lang.String message,
               java.lang.String[] argStr)
Method Detail

getDestination

public java.util.LinkedList getDestination()
Returns the destination of the message.


removeNextDestination

public void removeNextDestination()

resetDestination

public void resetDestination()

getNextDestIndex

public int getNextDestIndex()

setNextDestIndex

public void setNextDestIndex(int index)

getNextDestination

public java.lang.String getNextDestination(boolean adjust)

getMessageString

public java.lang.String getMessageString()
Returns the name of the message.


getArguments

public java.lang.String[] getArguments()
Get the arguments in the message.


setSourceMessageNode

public void setSourceMessageNode(vscript.message.MessageNode node)
Sets the sourceMessageNode of this message.


getSourceMessageNode

public vscript.message.MessageNode getSourceMessageNode()
Returns the source message node of this message.


constructMessage

public java.lang.String constructMessage()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

prepareMessage

public void prepareMessage(vscript.message.MessageNode node)
Prepare message prepares the message by filling in the values for all place holders.