soc.message
Class SOCMessageTemplateMi

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageMulti
          soc.message.SOCMessageTemplateMi

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SOCMessageForGame

Direct Known Subclasses:

SOCDiceResultResources, SOCPlayerElements, SOCPlayerStats

public abstract class SOCMessageTemplateMi
extends SOCMessageMulti
implements SOCMessageForGame

Template for message types with variable number of integer parameters. You will have to write parseDataStr, because of its subclass return type and because it's static.

Sample implementation: // format of s: POTENTIALSETTLEMENTS sep game sep2 settlecoord {sep2 settlecoord}*... // Must have at least game + 1 settlement param. public static SOCPotentialSettlements parseDataStr(String[] s) { String ga; // the game name int[] sett; // the settlements if ((s == null) || (s.length < 2)) return null; // must have at least game + 1 settlement param ga = s[0]; sett = new int[s.length - 1]; try { for (int i = 1; i < s.length; ++i) sett[i-1] = Integer.parseInt(s[i]); } catch (Exception e) { return null; } return new SOCPotentialSettlements(ga, sett); }

For notes on the section you must add to SOCMessage.toMsg(String), see SOCMessageMulti.

Since:

1.1.00

Author:

Jeremy D Monin <jeremy@nand.net>

See Also:

Serialized Form

Field Summary

protected java.lang.String	game Name of the game, or null if none.
protected int[]	pa Array of int parameters, or null if none.
private static long	serialVersionUID

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, AUTHREQUEST, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BOARDLAYOUT2, BOARDSPECIALEDGE, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DEBUGFREEPLACE, DELETECHANNEL, DELETEGAME, DEVCARDACTION, DEVCARDCOUNT, DICERESULT, DICERESULTRESOURCES, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAME_NONE, GAMEMEMBERS, GAMEOPTIONGETDEFAULTS, GAMEOPTIONGETINFOS, GAMEOPTIONINFO, GAMES, GAMESERVERTEXT, GAMESTATE, GAMESTATS, GAMESWITHOPTIONS, GAMETEXTMSG, IMAROBOT, INVENTORYITEMACTION, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LEGALEDGES, LOCALIZEDSTRINGS, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEPIECE, MOVEPIECEREQUEST, MOVEROBBER, NEWCHANNEL, NEWGAME, NEWGAMEWITHOPTIONS, NEWGAMEWITHOPTIONSREQUEST, NULLMESSAGE, PICKRESOURCES, PICKRESOURCESREQUEST, PIECEVALUE, PLAYDEVCARDREQUEST, PLAYERELEMENT, PLAYERELEMENTS, PLAYERSTATS, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, REMOVEPIECE, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, REVEALFOGHEX, ROBOTDISMISS, ROBOTJOINGAMEREQUEST, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, SCENARIOINFO, sep, sep_char, sep2, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETSPECIALITEM, SETTURN, SETUPDONE, SIMPLEACTION, SIMPLEREQUEST, SITDOWN, STARTGAME, STATUSMESSAGE, SVPTEXTMSG, TEXTMSG, TIMINGPING, TURN, UPDATEROBOTPARAMS, VERSION

Constructor Summary

protected

SOCMessageTemplateMi(int id, java.lang.String ga, int[] parr) Create a new multi-message with integer parameters.

Method Summary

java.lang.String	getGame() Name of game this message is for.
int[]	getParams()
java.lang.String	toCmd() MESSAGETYPE [sep game] sep param1 sep param2 sep ...
protected static java.lang.String	toCmd(int messageType, java.lang.String gaName, int[] parr) MESSAGETYPE [sep game] sep param1 sep param2 sep ...
java.lang.String	toString() Simple human-readable representation, used for debug purposes.

Methods inherited from class soc.message.SOCMessage

arrayIntoStringBuf, enumIntoStringBuf, getClassNameShort, getMaximumVersion, getMinimumVersion, getType, isSingleLineAndSafe, isSingleLineAndSafe, toMsg

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface soc.message.SOCMessageForGame

getType

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

game

protected java.lang.String game

Name of the game, or null if none.

pa

protected int[] pa

Array of int parameters, or null if none.

Although SOCMessageTemplateMs uses a List in v2.0.00 and newer, for now this class still uses an array for compact representation.

Constructor Detail

SOCMessageTemplateMi

protected SOCMessageTemplateMi(int id,
                               java.lang.String ga,
                               int[] parr)

Create a new multi-message with integer parameters.

Parameters:

id - Message type ID

ga - Name of game this message is for, or null if none

parr - Parameters, or null if none

Method Detail

getGame

public java.lang.String getGame()

Description copied from interface: SOCMessageForGame

Name of game this message is for. Must not be null if message is in per-game structures or code.

At the server, the message treater dispatches incoming SOCMessageForGames based on their getGame():

• null: Message is ignored
• SOCMessage.GAME_NONE: Message is handled by SOCServer itself
• Any other game name: Looks for a game with that name, to dispatch to the GameHandler for that game's type. If no game with that name is found, the message is ignored.

Specified by:

getGame in interface SOCMessageForGame

Returns:

the name of the game, or null if none

See Also:

SOCMessage.GAME_NONE

getParams

public int[] getParams()

Returns:

the parameters, or null if none

toCmd

public java.lang.String toCmd()

MESSAGETYPE [sep game] sep param1 sep param2 sep ...

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

protected static java.lang.String toCmd(int messageType,
                                        java.lang.String gaName,
                                        int[] parr)

MESSAGETYPE [sep game] sep param1 sep param2 sep ...

Parameters:

messageType - The message type id

gaName - the game name, or null

parr - The parameter array, or null if no additional parameters

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