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

java.lang.Object
  extended by org.jdesktop.wonderland.common.messages.Message
      extended by org.jdesktop.wonderland.common.cell.messages.CellMessage
          extended by org.jdesktop.wonderland.common.cell.messages.CellServerStateUpdateMessage
All Implemented Interfaces:
java.io.Serializable

public class CellServerStateUpdateMessage
extends CellMessage

Message sent to update a cell and cell component server state for a cell given its unique ID. This method is used to update the cell server state and individual cell component server states.

Author:
Jordan Slott
See Also:
Serialized Form

Constructor Summary
CellServerStateUpdateMessage(CellID cellID, CellServerState cellState, java.util.Set<CellComponentServerState> componentStateSet)
          Constructor that takes the unique ID of the cell and the server state (used to set the state) and a set of cell component server states.
 
Method Summary
 java.util.Set<CellComponentServerState> getCellComponentServerStateSet()
          Get the set of cell component server states from this message.
 CellServerState getCellServerState()
          Get the server state from this message.
 
Methods inherited from class org.jdesktop.wonderland.common.cell.messages.CellMessage
getCellID, getSenderID, setCellID, setSenderID
 
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

CellServerStateUpdateMessage

public CellServerStateUpdateMessage(CellID cellID,
                                    CellServerState cellState,
                                    java.util.Set<CellComponentServerState> componentStateSet)
Constructor that takes the unique ID of the cell and the server state (used to set the state) and a set of cell component server states.

Parameters:
cellID - The id of the cell
serverState - state
Method Detail

getCellServerState

public CellServerState getCellServerState()
Get the server state from this message. If this server state is null, then the cell's server state object should not be updated (although some of its component server state's may still be updated.

Returns:
the cell server state

getCellComponentServerStateSet

public java.util.Set<CellComponentServerState> getCellComponentServerStateSet()
Get the set of cell component server states from this message. If this set is null (or empty), then no cell component states are updated. Only the states in this set are updated; all other cell component server states are left alone.

Returns:
the set of cell component server states


Open Wonderland - http://openwonderland.org