soc.message
Class SOCChoosePlayer

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

public class SOCChoosePlayer
extends SOCMessage

This message says which player the current player wants to steal from.

Author:
Robert S. Thomas
See Also:
Serialized Form

Field Summary
private  int choice
          The number of the chosen player
private  java.lang.String game
          Name of game
 
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
SOCChoosePlayer(java.lang.String ga, int ch)
          Create a ChoosePlayer message.
 
Method Summary
 int getChoice()
           
 java.lang.String getGame()
           
static SOCChoosePlayer parseDataStr(java.lang.String s)
          Parse the command String into a ChoosePlayer message
 java.lang.String toCmd()
          CHOOSEPLAYER sep game sep2 choice
static java.lang.String toCmd(java.lang.String ga, int ch)
          CHOOSEPLAYER sep game sep2 choice
 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

game

private java.lang.String game
Name of game


choice

private int choice
The number of the chosen player

Constructor Detail

SOCChoosePlayer

public SOCChoosePlayer(java.lang.String ga,
                       int ch)
Create a ChoosePlayer message.

Parameters:
ga - the name of the game
ch - the number of the chosen player
Method Detail

getGame

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

getChoice

public int getChoice()
Returns:
the number of the chosen player

toCmd

public java.lang.String toCmd()
CHOOSEPLAYER sep game sep2 choice

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

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int ch)
CHOOSEPLAYER sep game sep2 choice

Parameters:
ga - the name of the game
ch - the number of the chosen player
Returns:
the command string

parseDataStr

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

Parameters:
s - the String to parse
Returns:
a ChoosePlayer 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