SOCMessageTemplateMi

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 SOCMessageTemplateMi

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

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

public abstract class SOCMessageTemplateMi
extends SOCMessageMulti

Template for per-game message types with variable number of integer parameters. You will have to write parseDataStr, because of its 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); }

Author:: Jeremy D Monin
See Also:: Serialized Form

Field Summary
`protected java.lang.String`	`game` Name of the game.
`protected int[]`	`pa` Array of int parameters, or null if none.

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`	`SOCMessageTemplateMi(int id, java.lang.String ga, int[] parr)` Create a new multi-message with integer parameters.

Method Summary
`java.lang.String`	`getGame()`
`int[]`	`getParams()`
`java.lang.String`	`toCmd()` MESSAGETYPE sep game sep2 param
`static java.lang.String`	`toCmd(int messageType, java.lang.String ga, 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

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.

pa

protected int[] pa

Array of int parameters, or null if none.

Constructor Detail