soc.message
Class SOCStatusMessage

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCStatusMessage

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SOCStatusMessage

extends SOCMessage

This is a text message that shows in a status box on the client. Used for "welcome" message at initial connect (follows JOINAUTH).

Author:

Robert S. Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String

status Status message

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

SOCStatusMessage(java.lang.String st)
Create a StatusMessage message.

Method Summary

java.lang.String	getStatus()
static SOCStatusMessage	parseDataStr(java.lang.String s) Parse the command String into a StatusMessage message
java.lang.String	toCmd() STATUSMESSAGE sep game
static java.lang.String	toCmd(java.lang.String st) STATUSMESSAGE sep status
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

status

private java.lang.String status

Status message

Constructor Detail

SOCStatusMessage

public SOCStatusMessage(java.lang.String st)

Create a StatusMessage message.

Parameters:

st - the status

Method Detail

getStatus

public java.lang.String getStatus()

Returns:

the status

toCmd

public java.lang.String toCmd()

STATUSMESSAGE sep game

Specified by:

toCmd in class SOCMessage

Returns:

the command string

toCmd

public static java.lang.String toCmd(java.lang.String st)

STATUSMESSAGE sep status

Parameters:

st - the status

Returns:

the command string

parseDataStr

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

Parse the command String into a StatusMessage message

Parameters:

s - the String to parse

Returns:

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