|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object soc.message.SOCMessage soc.message.SOCDiscoveryPick
public class SOCDiscoveryPick
This message says which resources the player picked for a Discovery card
Field Summary | |
---|---|
private java.lang.String |
game
Name of game |
private SOCResourceSet |
resources
The chosen resources |
private static long |
serialVersionUID
|
Constructor Summary | |
---|---|
SOCDiscoveryPick(java.lang.String ga,
SOCResourceSet rs)
Create a DiscoveryPick message. |
Method Summary | |
---|---|
java.lang.String |
getGame()
Name of game this message is for. |
SOCResourceSet |
getResources()
|
static SOCDiscoveryPick |
parseDataStr(java.lang.String s)
Parse the command String into a DiscoveryPick 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 rs)
|
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 |
---|
private static final long serialVersionUID
private java.lang.String game
private SOCResourceSet resources
Constructor Detail |
---|
public SOCDiscoveryPick(java.lang.String ga, SOCResourceSet rs)
ga
- the name of the gamers
- the chosen resourcesMethod Detail |
---|
public java.lang.String getGame()
SOCMessageForGame
null
if message is in per-game structures or code.
At the server, the message treater dispatches incoming SOCMessageForGame
s
based on their getGame()
:
null
: Message is ignored
SOCMessage.GAME_NONE
: Message is handled by SOCServer
itself
GameHandler
for that game's type. If no game with that name is found,
the message is ignored.
getGame
in interface SOCMessageForGame
SOCMessage.GAME_NONE
public SOCResourceSet getResources()
public java.lang.String toCmd()
SOCMessage
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[])
toCmd
in class SOCMessage
public static java.lang.String toCmd(java.lang.String ga, SOCResourceSet rs)
ga
- the name of the gamers
- the chosen resources
public static SOCDiscoveryPick parseDataStr(java.lang.String s)
s
- the String to parse
public java.lang.String toString()
SOCMessage
toString
in class SOCMessage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |