soc.message
Class SOCLeaveGame

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCLeaveGame

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCLeaveGame

extends SOCMessage

This message means that someone is leaveing a game

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	game Name of game
private java.lang.String	host Host name
private java.lang.String	nickname Nickname of the leaveing member

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

SOCLeaveGame(java.lang.String nn, java.lang.String hn, java.lang.String ga)
Create a LeaveGame message.

Method Summary

java.lang.String	getGame()
java.lang.String	getHost()
java.lang.String	getNickname()
static SOCLeaveGame	parseDataStr(java.lang.String s) Parse the command String into a Leave message
java.lang.String	toCmd() LEAVEGAME sep nickname sep2 host sep2 game
static java.lang.String	toCmd(java.lang.String nn, java.lang.String hn, java.lang.String ga) LEAVEGAME sep nickname sep2 host sep2 game
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

nickname

private java.lang.String nickname

Nickname of the leaveing member

game

private java.lang.String game

Name of game

host

private java.lang.String host

Host name

Constructor Detail

SOCLeaveGame

public SOCLeaveGame(java.lang.String nn,
                    java.lang.String hn,
                    java.lang.String ga)

Create a LeaveGame message.

Parameters:

nn - nickname

hn - host name

ga - name of game

Method Detail

getNickname

public java.lang.String getNickname()

Returns:

the nickname

getHost

public java.lang.String getHost()

Returns:

the host name

getGame

public java.lang.String getGame()

Returns:

the game name

toCmd

public java.lang.String toCmd()

LEAVEGAME sep nickname sep2 host sep2 game

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String nn,
                                     java.lang.String hn,
                                     java.lang.String ga)

LEAVEGAME sep nickname sep2 host sep2 game

Parameters:

nn - the neckname

hn - the host name

ga - the name of the game

Returns:

the command string

parseDataStr

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

Parse the command String into a Leave message

Parameters:

s - the String to parse

Returns:

a LeaveGame 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