soc.message
Class SOCSetSeatLock

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCSetSeatLock

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCSetSeatLock

extends SOCMessage

This message sets the lock state of a seat.

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

SOCSetSeatLock(java.lang.String ga, int pn, boolean st)
Create a SetSeatLock message.

Method Summary

java.lang.String	getGame()
boolean	getLockState()
int	getPlayerNumber()
static SOCSetSeatLock	parseDataStr(java.lang.String s) Parse the command String into a SetSeatLock message
java.lang.String	toCmd() SETSEATLOCK sep game sep2 playerNumber sep2 state
static java.lang.String	toCmd(java.lang.String ga, int pn, boolean st) SETSEATLOCK sep game sep2 playerNumber sep2 state
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

SOCSetSeatLock

public SOCSetSeatLock(java.lang.String ga,
                      int pn,
                      boolean st)

Create a SetSeatLock message.

Parameters:

ga - the name of the game

pn - the number of the changing player

st - the state of the lock

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getPlayerNumber

public int getPlayerNumber()

Returns:

the number of changing player

getLockState

public boolean getLockState()

Returns:

the state of the lock

toCmd

public java.lang.String toCmd()

SETSEATLOCK sep game sep2 playerNumber sep2 state

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pn,
                                     boolean st)

SETSEATLOCK sep game sep2 playerNumber sep2 state

Parameters:

ga - the name of the game

pn - the number of the changing player

st - the state of the lock

Returns:

the command string

parseDataStr

public static SOCSetSeatLock parseDataStr(java.lang.String s)

Parse the command String into a SetSeatLock message

Parameters:

s - the String to parse

Returns:

a SetSeatLock message, or null of the data is garbled

toString

public java.lang.String toString()

Returns:

a human readable form of the message