soc.message
Class SOCMessageTemplate3i

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate3i

All Implemented Interfaces:

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

Direct Known Subclasses:

SOCPieceValue, SOCRemovePiece, SOCRevealFogHex

public abstract class SOCMessageTemplate3i
extends SOCMessage
implements SOCMessageForGame

Template for per-game message types with 3 integer parameters. Your class javadoc should explain the meaning of param1, param2, and param3, so that you won't need to write getters for those.

You will have to write parseDataStr, because of its return type and because it's static.

Sample implementation:

   // format of s: game sep2 hexcoord sep2 hextype sep2 dicenum
   public static SOCRevealFogHex parseDataStr(final String s)
   {
       String ga; // the game name
       int hc; // the hex coordinate
       int ht; // hex type
       int dn; // dice number

       StringTokenizer st = new StringTokenizer(s, sep2);

       try
       {
           ga = st.nextToken();
           hc = Integer.parseInt(st.nextToken());
           ht = Integer.parseInt(st.nextToken());
           dn = Integer.parseInt(st.nextToken());
       }
       catch (Exception e)
       {
           return null;
       }

        return new SOCRevealFogHex(ga, hc, ht, dn);
   }

Since:

2.0.00

Author:

Jeremy D Monin <jeremy@nand.net>

See Also:

Serialized Form

Field Summary

protected java.lang.String	game Name of the game.
protected int	p1 First integer parameter.
protected int	p2 Second integer parameter.
protected int	p3 Third integer parameter.
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

SOCMessageTemplate3i(int id, java.lang.String ga, int param1, int param2, int param3) Create a new message.

Method Summary

java.lang.String	getGame() Name of game this message is for.
int	getParam1()
int	getParam2()
int	getParam3()
java.lang.String	toCmd() MESSAGETYPE sep game sep2 param1 sep2 param2 sep2 param3
protected static java.lang.String	toCmd(int messageType, java.lang.String ga, int param1, int param2, int param3) MESSAGETYPE sep game sep2 param1 sep2 param2 sep2 param3
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.

p1

protected int p1

First integer parameter.

p2

protected int p2

Second integer parameter.

p3

protected int p3

Third integer parameter.

Constructor Detail

SOCMessageTemplate3i

protected SOCMessageTemplate3i(int id,
                               java.lang.String ga,
                               int param1,
                               int param2,
                               int param3)

Create a new message.

Parameters:

id - Message type ID

ga - Name of game this message is for

param1 - Parameter 1

param2 - Parameter 2

param3 - Parameter 3

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

See Also:

SOCMessage.GAME_NONE

getParam1

public int getParam1()

Returns:

the first parameter

getParam2

public int getParam2()

Returns:

the second parameter

getParam3

public int getParam3()

Returns:

the third parameter

toCmd

public java.lang.String toCmd()

MESSAGETYPE sep game sep2 param1 sep2 param2 sep2 param3

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

protected static java.lang.String toCmd(int messageType,
                                        java.lang.String ga,
                                        int param1,
                                        int param2,
                                        int param3)

MESSAGETYPE sep game sep2 param1 sep2 param2 sep2 param3

Parameters:

messageType - The message type id

ga - the game name

param1 - The first parameter

param2 - The second parameter

param3 - The third 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