soc.message
Class SOCTextMsg

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCTextMsg

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SOCTextMsg
extends SOCMessage

This message contains a text message

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	channel Name of channel
private java.lang.String	nickname Nickname of sender
private static java.lang.String	sep2 our token seperator
private static long	serialVersionUID
private java.lang.String	text Text message

Fields inherited from class soc.message.SOCMessage

ACCEPTOFFER, ADMINPING, ADMINRESET, AUTHREQUEST, BANKTRADE, BCASTTEXTMSG, BOARDLAYOUT, BOARDLAYOUT2, BOARDSPECIALEDGE, BUILDREQUEST, BUYCARDREQUEST, CANCELBUILDREQUEST, CHANGEFACE, CHANNELS, CHOOSEPLAYER, CHOOSEPLAYERREQUEST, CLEAROFFER, CLEARTRADEMSG, CREATEACCOUNT, DEBUGFREEPLACE, DELETECHANNEL, DELETEGAME, DEVCARDACTION, DEVCARDCOUNT, DICERESULT, DICERESULTRESOURCES, DISCARD, DISCARDREQUEST, DISCOVERYPICK, ENDTURN, FIRSTPLAYER, GAME_NONE, GAMEMEMBERS, GAMEOPTIONGETDEFAULTS, GAMEOPTIONGETINFOS, GAMEOPTIONINFO, GAMES, GAMESERVERTEXT, GAMESTATE, GAMESTATS, GAMESWITHOPTIONS, GAMETEXTMSG, IMAROBOT, INVENTORYITEMACTION, JOIN, JOINAUTH, JOINGAME, JOINGAMEAUTH, LARGESTARMY, LASTSETTLEMENT, LEAVE, LEAVEALL, LEAVEGAME, LEGALEDGES, LOCALIZEDSTRINGS, LONGESTROAD, MAKEOFFER, MEMBERS, messageType, MONOPOLYPICK, MOVEPIECE, MOVEPIECEREQUEST, MOVEROBBER, NEWCHANNEL, NEWGAME, NEWGAMEWITHOPTIONS, NEWGAMEWITHOPTIONSREQUEST, NULLMESSAGE, PICKRESOURCES, PICKRESOURCESREQUEST, PIECEVALUE, PLAYDEVCARDREQUEST, PLAYERELEMENT, PLAYERELEMENTS, PLAYERSTATS, POTENTIALSETTLEMENTS, PUTPIECE, REJECTCONNECTION, REJECTOFFER, REMOVEPIECE, RESETBOARDAUTH, RESETBOARDREJECT, RESETBOARDREQUEST, RESETBOARDVOTE, RESETBOARDVOTEREQUEST, RESOURCECOUNT, REVEALFOGHEX, ROBOTDISMISS, ROBOTJOINGAMEREQUEST, ROLLDICE, ROLLDICEPROMPT, ROLLDICEREQUEST, SCENARIOINFO, sep, sep_char, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETSPECIALITEM, SETTURN, SETUPDONE, SIMPLEACTION, SIMPLEREQUEST, SITDOWN, STARTGAME, STATUSMESSAGE, SVPTEXTMSG, TEXTMSG, TIMINGPING, TURN, UPDATEROBOTPARAMS, VERSION

Constructor Summary

SOCTextMsg(java.lang.String ch, java.lang.String nn, java.lang.String tm)
Create a TextMsg message.

Method Summary

java.lang.String	getChannel()
java.lang.String	getNickname()
java.lang.String	getText()
static SOCTextMsg	parseDataStr(java.lang.String s) Parse the command String into a TextMsg message
java.lang.String	toCmd() TEXTMSG sep channel sep2 nickname sep2 text
static java.lang.String	toCmd(java.lang.String ch, java.lang.String nn, java.lang.String tm) TEXTMSG sep channel sep2 nickname sep2 text
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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

sep2

private static java.lang.String sep2

our token seperator

channel

private java.lang.String channel

Name of channel

nickname

private java.lang.String nickname

Nickname of sender

text

private java.lang.String text

Text message

Constructor Detail

SOCTextMsg

public SOCTextMsg(java.lang.String ch,
                  java.lang.String nn,
                  java.lang.String tm)

Create a TextMsg message.

Parameters:

ch - name of chat channel

nn - nickname of sender

tm - text message

Method Detail

getChannel

public java.lang.String getChannel()

Returns:

the channel name

getNickname

public java.lang.String getNickname()

Returns:

the nickname

getText

public java.lang.String getText()

Returns:

the text message

toCmd

public java.lang.String toCmd()

TEXTMSG sep channel sep2 nickname sep2 text

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String ch,
                                     java.lang.String nn,
                                     java.lang.String tm)

TEXTMSG sep channel sep2 nickname sep2 text

Parameters:

ch - the channel name

nn - the nickname

tm - the text message

Returns:

the command string

parseDataStr

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

Parse the command String into a TextMsg message

Parameters:

s - the String to parse

Returns:

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