soc.message
Class SOCBuildRequest

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCBuildRequest

extends SOCMessage

This message says which player the current player wants to steal from.

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

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

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

Method Summary

java.lang.String	getGame()
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

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

pieceType

private int pieceType

The type of piece to build

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

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getPieceType

public int getPieceType()

Returns:

the type of piece to build

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

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