soc.message
Class SOCGames

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

public class SOCGames
extends SOCMessage

This message lists all the soc games on a server

Author:
Robert S Thomas
See Also:
Serialized Form

Field Summary
private  java.util.Vector games
          List of games
 
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, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS, VERSION
 
Constructor Summary
SOCGames(java.util.Vector ga)
          Create a Games Message.
 
Method Summary
 java.util.Vector getGames()
           
static SOCGames parseDataStr(java.lang.String s)
          Parse the command String into a Games message
 java.lang.String toCmd()
          GAMES sep games
static java.lang.String toCmd(java.util.Vector ga)
          GAMES sep games
 java.lang.String toString()
          Simple human-readable representation, used for debug purposes.
 
Methods inherited from class soc.message.SOCMessage
getMaximumVersion, getMinimumVersion, getType, toMsg, toSingleElemArray
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

games

private java.util.Vector games
List of games

Constructor Detail

SOCGames

public SOCGames(java.util.Vector ga)
Create a Games Message.

Parameters:
ga - list of games
Method Detail

getGames

public java.util.Vector getGames()
Returns:
the list of games

toCmd

public java.lang.String toCmd()
GAMES sep games

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

toCmd

public static java.lang.String toCmd(java.util.Vector ga)
GAMES sep games

Parameters:
ga - the list of games
Returns:
the command string

parseDataStr

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

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

toString

public java.lang.String toString()
Description copied from class: SOCMessage
Simple human-readable representation, used for debug purposes.

Specified by:
toString in class SOCMessage
Returns:
a human readable form of the message