SOCMessageTemplate2i

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

soc.message
Class SOCMessageTemplate2i

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMessageTemplate2i

All Implemented Interfaces:: java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:: SOCResetBoardAuth, SOCResetBoardVote

public abstract class SOCMessageTemplate2i
extends SOCMessage

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

Sample implementation: // format of s: LONGESTROAD sep game sep2 seatnumber sep2 coordinates public static SOCLongestRoad parseDataStr(String s) { String ga; // the game name int pn; // the seat number int co; // coordinates StringTokenizer st = new StringTokenizer(s, sep2); try { ga = st.nextToken(); pn = Integer.parseInt(st.nextToken()); co = Integer.parseInt(st.nextToken()); } catch (Exception e) { return null; } return new SOCMoveRobber(ga, pn, co); }

Author:: Jeremy D Monin
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.

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`	`SOCMessageTemplate2i(int id, java.lang.String ga, int p1, int p2)` Create a new message.

Method Summary
`java.lang.String`	`getGame()`
`int`	`getParam1()`
`int`	`getParam2()`
`java.lang.String`	`toCmd()` MESSAGETYPE sep game sep2 param1 sep2 param2
`static java.lang.String`	`toCmd(int messageType, java.lang.String ga, int param1, int param2)` MESSAGETYPE sep game sep2 param1 sep2 param2
`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 int p1

First integer parameter.

p2

protected int p2

Second integer parameter.

Constructor Detail