soc.message
Class SOCDiscard

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCDiscard

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCDiscard

extends SOCMessage

This message means that a player is discarding

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

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, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEREQUEST, sep, sep2, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS

Constructor Summary

SOCDiscard(java.lang.String ga, int cl, int or, int sh, int wh, int wo, int uk)
Create a Discard message.

SOCDiscard(java.lang.String ga, int pn, SOCResourceSet rs)
Create a Discard message.

Method Summary

java.lang.String	getGame()
SOCResourceSet	getResources()
static SOCDiscard	parseDataStr(java.lang.String s) Parse the command String into a Discard message
java.lang.String	toCmd() DISCARD sep game sep2 clay sep2 ore sep2 sheep sep2 wheat sep2 wood sep2 unknown
static java.lang.String	toCmd(java.lang.String ga, int cl, int or, int sh, int wh, int wo, int uk) DISCARD sep game sep2 clay sep2 ore sep2 sheep sep2 wheat sep2 wood sep2 unknown
static java.lang.String	toCmd(java.lang.String ga, SOCResourceSet rs) DISCARD sep game sep2 clay sep2 ore sep2 sheep sep2 wheat sep2 wood sep2 unknown
java.lang.String	toString()

Methods inherited from class soc.message.SOCMessage

getType, toMsg

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SOCDiscard

public SOCDiscard(java.lang.String ga,
                  int cl,
                  int or,
                  int sh,
                  int wh,
                  int wo,
                  int uk)

Create a Discard message.

Parameters:

ga - the name of the game

cl - the ammount of clay being discarded

or - the ammount of ore being discarded

sh - the ammount of sheep being discarded

wh - the ammount of wheat being discarded

wo - the ammount of wood being discarded

uk - the ammount of unknown resources being discarded

SOCDiscard

public SOCDiscard(java.lang.String ga,
                  int pn,
                  SOCResourceSet rs)

Create a Discard message.

Parameters:

ga - the name of the game

rs - the resources being discarded

Method Detail

getGame

public java.lang.String getGame()

Returns:

the name of the game

getResources

public SOCResourceSet getResources()

Returns:

the set of resources being discarded

toCmd

public java.lang.String toCmd()

DISCARD sep game sep2 clay sep2 ore sep2 sheep sep2 wheat sep2 wood sep2 unknown

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

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

DISCARD sep game sep2 clay sep2 ore sep2 sheep sep2 wheat sep2 wood sep2 unknown

Parameters:

ga - the name of the game

rs - the resources being discarded

Returns:

the command string

toCmd

public static java.lang.String toCmd(java.lang.String ga,
                                     int cl,
                                     int or,
                                     int sh,
                                     int wh,
                                     int wo,
                                     int uk)

DISCARD sep game sep2 clay sep2 ore sep2 sheep sep2 wheat sep2 wood sep2 unknown

Parameters:

ga - the name of the game

cl - the ammount of clay being discarded

or - the ammount of ore being discarded

sh - the ammount of sheep being discarded

wh - the ammount of wheat being discarded

wo - the ammount of wood being discarded

uk - the ammount of unknown resources being discarded

Returns:

the command string

parseDataStr

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

Parse the command String into a Discard message

Parameters:

s - the String to parse

Returns:

a Discard message, or null of the data is garbled

toString

public java.lang.String toString()

Returns:

a human readable form of the message