soc.message
Class SOCJoinGame

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCJoinGame

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCJoinGame

extends SOCMessage

This message means that someone is joining 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

SOCJoinGame(java.lang.String nn, java.lang.String pw, java.lang.String hn, java.lang.String ga)
Create a Join message.

Method Summary

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

SOCJoinGame

public SOCJoinGame(java.lang.String nn,
                   java.lang.String pw,
                   java.lang.String hn,
                   java.lang.String ga)

Create a Join message.

Parameters:

nn - nickname

pw - password

hn - host name

ga - name of the game

Method Detail

getNickname

public java.lang.String getNickname()

Returns:

the nickname

getPassword

public java.lang.String getPassword()

Returns:

the password

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()

JOINGAME sep nickname sep2 password 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 pw,
                                     java.lang.String hn,
                                     java.lang.String ga)

JOINGAME sep nickname sep2 password sep2 host sep2 game

Parameters:

nn - the nickname

pw - the password

hn - the host name

ga - the game name

Returns:

the command string

parseDataStr

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

Parse the command String into a JoinGame message

Parameters:

s - the String to parse

Returns:

a JoinGame message, or null of the data is garbled

toString

public java.lang.String toString()

Returns:

a human readable form of the message