soc.message
Class SOCBankTrade

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCBankTrade

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCBankTrade

extends SOCMessage

This message means that a player wants to trade with the bank

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	game Name of game
private SOCResourceSet	get The set of resources being taken from the bank
private SOCResourceSet	give The set of resources being given to the bank

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

SOCBankTrade(java.lang.String ga, SOCResourceSet give, SOCResourceSet get)
Create a BankTrade message.

Method Summary

java.lang.String	getGame()
SOCResourceSet	getGetSet()
SOCResourceSet	getGiveSet()
static SOCBankTrade	parseDataStr(java.lang.String s) Parse the command String into a BankTrade message
java.lang.String	toCmd() Converts the contents of this message into a String that can be transferred by a client or server.
static java.lang.String	toCmd(java.lang.String ga, SOCResourceSet give, SOCResourceSet get)
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

give

private SOCResourceSet give

The set of resources being given to the bank

get

private SOCResourceSet get

The set of resources being taken from the bank

Constructor Detail

SOCBankTrade

public SOCBankTrade(java.lang.String ga,
                    SOCResourceSet give,
                    SOCResourceSet get)

Create a BankTrade message.

Parameters:

ga - the name of the game

give - the set of resources being given to the bank

get - the set of resources being taken from the bank

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getGiveSet

public SOCResourceSet getGiveSet()

Returns:

the set of resources being given to the bank

getGetSet

public SOCResourceSet getGetSet()

Returns:

the set of resources being taken from the bank

toCmd

public java.lang.String toCmd()

Description copied from class: SOCMessage

Converts the contents of this message into a String that can be transferred by a client or server. Your class' required method static SOCMessageSubclass parseDataStr(String) must be able to turn this String back into an instance of the message class.

For most message types, at most one SOCMessage.sep token is allowed, separating the type ID from the rest of the parameters. For multi-messages (@link SOCMessageMulti}, multiple SOCMessage.sep tokens are allowed. Multi-messages are parsed with: static SOCMessageSubclass parseDataStr(String[])

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     SOCResourceSet give,
                                     SOCResourceSet get)

Parameters:

ga - the name of the game

give - the set of resources being given to the bank

get - the set of resources being taken from the bank

Returns:

the command string

parseDataStr

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

Parse the command String into a BankTrade message

Parameters:

s - the String to parse

Returns:

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