JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCGameMembers

java.lang.Object
  extended bysoc.message.SOCMessage
      extended bysoc.message.SOCGameMembers
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SOCGameMembers
extends SOCMessage

This message lists all the members of a game

Author:
Robert S Thomas
See Also:
Serialized Form

Field Summary
 
Fields inherited from class soc.message.SOCMessage
ACCEPTOFFER, ADMINPING, ADMINRESET, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DELETECHANNEL, DELETEGAME, DEVCARD, DEVCARDCOUNT, DICERESULT, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAMEMEMBERS, GAMES, GAMESTATE, GAMESTATS, GAMETEXTMSG, IMAROBOT, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, JOINGAMEREQUEST, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEROBBER, NEWCHANNEL, NEWGAME, NULLMESSAGE, PLAYDEVCARDREQUEST, PLAYERELEMENT, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEREQUEST, sep, sep2, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS
 
Constructor Summary
SOCGameMembers(java.lang.String ga, java.util.Vector ml)
          Create a GameMembers message.
 
Method Summary
 java.lang.String getGame()
           
 java.util.Vector getMembers()
           
static SOCGameMembers parseDataStr(java.lang.String s)
          Parse the command String into a Members message
 java.lang.String toCmd()
          GAMEMEMBERS sep game sep2 members
static java.lang.String toCmd(java.lang.String ga, java.util.Vector ml)
          GAMEMEMBERS sep game sep2 members
 java.lang.String toString()
           
 
Methods inherited from class soc.message.SOCMessage
getType, toMsg
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SOCGameMembers

public SOCGameMembers(java.lang.String ga,
                      java.util.Vector ml)
Create a GameMembers message.

Parameters:
ga - name of game
ml - list of members
Method Detail

getMembers

public java.util.Vector getMembers()
Returns:
the list of members

getGame

public java.lang.String getGame()
Returns:
the game name

toCmd

public java.lang.String toCmd()
GAMEMEMBERS sep game sep2 members

Specified by:
toCmd in class SOCMessage
Returns:
the command String

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     java.util.Vector ml)
GAMEMEMBERS sep game sep2 members

Parameters:
ga - the game name
ml - the list of members
Returns:
the command string

parseDataStr

public static SOCGameMembers parseDataStr(java.lang.String s)
Parse the command String into a Members message

Parameters:
s - the String to parse
Returns:
a Members message, or null of the data is garbled

toString

public java.lang.String toString()
Returns:
a human readable form of the message

JSettlers v1.0.6 API
Built ${date}