soc.message
Class SOCBuildRequest

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCBuildRequest

All Implemented Interfaces:

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

public class SOCBuildRequest
extends SOCMessage
implements SOCMessageForGame

This message, from client to server, says which piece type the current player wants to build.

During game state PLAY1, this is a build request during the player's turn. When sent during other game states, and other players' turns, this is a request to start the 6-player Special Building Phase.

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	game Name of game
private int	pieceType The type of piece to build, from SOCPlayingPiece constants, or -1 to request the Special Building Phase.
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

SOCBuildRequest(java.lang.String ga, int pt)
Create a BuildRequest message.

Method Summary

java.lang.String	getGame() Name of game this message is for.
int	getPieceType()
static SOCBuildRequest	parseDataStr(java.lang.String s) Parse the command String into a BuildRequest message
java.lang.String	toCmd() BUILDREQUEST sep game sep2 pieceType
static java.lang.String	toCmd(java.lang.String ga, int pt) BUILDREQUEST sep game sep2 pieceType
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

private java.lang.String game

Name of game

pieceType

private int pieceType

The type of piece to build, from SOCPlayingPiece constants, or -1 to request the Special Building Phase.

Constructor Detail

SOCBuildRequest

public SOCBuildRequest(java.lang.String ga,
                       int pt)

Create a BuildRequest message.

Parameters:

ga - the name of the game

pt - the type of piece to build, from SOCPlayingPiece constants, or -1 to request the Special Building Phase.

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

getPieceType

public int getPieceType()

Returns:

the type of piece to build, from SOCPlayingPiece constants, or -1 to request the Special Building Phase.

toCmd

public java.lang.String toCmd()

BUILDREQUEST sep game sep2 pieceType

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int pt)

BUILDREQUEST sep game sep2 pieceType

Parameters:

ga - the name of the game

pt - the type of piece to build, or -1 for Special Building Phase

Returns:

the command string

parseDataStr

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

Parse the command String into a BuildRequest message

Parameters:

s - the String to parse

Returns:

a BuildRequest 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