soc.message
Class SOCMessageTemplate0

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate0

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

SOCResetBoardReject, SOCResetBoardRequest

public abstract class SOCMessageTemplate0

extends SOCMessage

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

Sample implementation: public static SOCAdminPing parseDataStr(String s) { return new SOCAdminPing(s); }

Author:

Jeremy D Monin

See Also:

Serialized Form

Field Summary

protected java.lang.String

game Name of the 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

protected

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

Method Summary

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

game

protected java.lang.String game

Name of the game.

Constructor Detail

SOCMessageTemplate0

protected SOCMessageTemplate0(int id,
                              java.lang.String ga)

Create a new message.

Parameters:

id - Message type ID

ga - Name of game this message is for

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

toCmd

public java.lang.String toCmd()

MESSAGETYPE sep game

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

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

MESSAGETYPE sep game

Parameters:

messageType - The message type id

ga - the game name

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