soc.message
Class SOCMessageTemplate1s

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate1s

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public abstract class SOCMessageTemplate1s

extends SOCMessage

Template for per-game message types with 1 string parameter. You will have to write parseDataStr, because of its return type and because it's static.

Sample implementation: public static SOCSitDown parseDataStr(String s) { String ga; // the game name String pna; // the player name StringTokenizer st = new StringTokenizer(s, sep2); try { ga = st.nextToken(); pna = st.nextToken(); } catch (Exception e) { return null; } return new SOCSitDown(ga, pn); }

Author:

Jeremy D Monin

See Also:

Serialized Form

Field Summary

protected java.lang.String	game Name of the game.
protected java.lang.String	p1 Single string parameter.

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

protected

SOCMessageTemplate1s(int id, java.lang.String ga, java.lang.String p) Create a new message.

Method Summary

java.lang.String	getGame()
java.lang.String	getParam()
java.lang.String	toCmd() MESSAGETYPE sep game sep2 param
static java.lang.String	toCmd(int messageType, java.lang.String ga, java.lang.String param) MESSAGETYPE sep game sep2 param
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

protected java.lang.String game

Name of the game.

p1

protected java.lang.String p1

Single string parameter.

Constructor Detail

SOCMessageTemplate1s

protected SOCMessageTemplate1s(int id,
                               java.lang.String ga,
                               java.lang.String p)

Create a new message.

Parameters:

id - Message type ID

ga - Name of game this message is for

p - Parameter

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getParam

public java.lang.String getParam()

Returns:

the single parameter

toCmd

public java.lang.String toCmd()

MESSAGETYPE sep game sep2 param

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(int messageType,
                                     java.lang.String ga,
                                     java.lang.String param)

MESSAGETYPE sep game sep2 param

Parameters:

messageType - The message type id

ga - the game name

param - The parameter

Returns:

the command string

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