org.jdesktop.wonderland.common.cell.messages
Class CellMessage

java.lang.Object
  extended by org.jdesktop.wonderland.common.messages.Message
      extended by org.jdesktop.wonderland.common.cell.messages.CellMessage
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CellChannelComponentRequestMessage, CellClientComponentMessage, CellClientStateMessage, CellServerComponentMessage, CellServerStateRequestMessage, CellServerStateSetMessage, CellServerStateUpdateMessage, MovableMessage

public abstract class CellMessage
extends Message

Message sent to a particular cell.

Author:
jkaplan
See Also:
Serialized Form

Constructor Summary
CellMessage()
          Create a new cell message.
CellMessage(CellID cellID)
          Create a new cell message to the given cellID on the server
 
Method Summary
 CellID getCellID()
          Get the ID of the cell this message is being sent to
 java.math.BigInteger getSenderID()
          Get the ID of this message's sender.
 void setCellID(CellID cellID)
          Set the ID of the cell this message is being sent to.
 void setSenderID(java.math.BigInteger senderID)
          Set the ID of this message's sender.
 
Methods inherited from class org.jdesktop.wonderland.common.messages.Message
getMessageID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CellMessage

public CellMessage()
Create a new cell message. The cellID will be set automatically when the message is sent.


CellMessage

public CellMessage(CellID cellID)
Create a new cell message to the given cellID on the server

Parameters:
cellID - the id of the cell to send to
Method Detail

getCellID

public CellID getCellID()
Get the ID of the cell this message is being sent to

Returns:
the cellID

setCellID

public void setCellID(CellID cellID)
Set the ID of the cell this message is being sent to. If the message is created without a CellID, this value will be filled in automatically by the sender.

Parameters:
cellID - the cellID to set

getSenderID

public java.math.BigInteger getSenderID()
Get the ID of this message's sender. This is only valid on messages sent from the server to the client.

Returns:
the sender's ID, identical to calling WonderlandSession.getSessionID() on the client session. If the sender's ID is not set, this method will return null. A null ID typically means a message that originated at the server and not with a particular client.

setSenderID

public void setSenderID(java.math.BigInteger senderID)
Set the ID of this message's sender. This value will be filled in automatically by the server when sending a message that originated with a client.

Parameters:
senderID - the sender's id.


Open Wonderland - http://openwonderland.org