soc.message
Class SOCPotentialSettlements

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCPotentialSettlements

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCPotentialSettlements

extends SOCMessage

This message contains a list of potential settlements

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	game Name of game
private int	playerNumber Player number
private java.util.Vector	psList List of potential settlements

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

SOCPotentialSettlements(java.lang.String ga, int pn, java.util.Vector ps)
Create a SOCPotentialSettlements message.

Method Summary

java.lang.String	getGame()
int	getPlayerNumber()
java.util.Vector	getPotentialSettlements()
static SOCPotentialSettlements	parseDataStr(java.lang.String s) Parse the command String into a PotentialSettlements message
java.lang.String	toCmd() POTENTIALSETTLEMENTS sep game sep2 playerNumber sep2 psList
static java.lang.String	toCmd(java.lang.String ga, int pn, java.util.Vector ps) POTENTIALSETTLEMENTS sep game sep2 playerNumber sep2 psList
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

private java.lang.String game

Name of game

playerNumber

private int playerNumber

Player number

psList

private java.util.Vector psList

List of potential settlements

Constructor Detail

SOCPotentialSettlements

public SOCPotentialSettlements(java.lang.String ga,
                               int pn,
                               java.util.Vector ps)

Create a SOCPotentialSettlements message.

Parameters:

ga - name of the game

pn - the player number

ps - the list of potential settlements

Method Detail

getGame

public java.lang.String getGame()

Returns:

the game name

getPlayerNumber

public int getPlayerNumber()

Returns:

the player number

getPotentialSettlements

public java.util.Vector getPotentialSettlements()

Returns:

the list of potential settlements

toCmd

public java.lang.String toCmd()

POTENTIALSETTLEMENTS sep game sep2 playerNumber sep2 psList

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pn,
                                     java.util.Vector ps)

POTENTIALSETTLEMENTS sep game sep2 playerNumber sep2 psList

Parameters:

ga - the game name

pn - the player number

ps - the list of potential settlements

Returns:

the command string

parseDataStr

public static SOCPotentialSettlements parseDataStr(java.lang.String s)

Parse the command String into a PotentialSettlements message

Parameters:

s - the String to parse

Returns:

a PotentialSettlements message, or null of the data is garbled

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