soc.message
Class SOCLeave

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCLeave

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SOCLeave
extends SOCMessage

This message means that someone is leaveing a channel

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	channel Name of channel
private java.lang.String	host Host name
private java.lang.String	nickname Nickname of the leaveing member
private static long	serialVersionUID

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, sep2_char, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETSPECIALITEM, SETTURN, SETUPDONE, SIMPLEACTION, SIMPLEREQUEST, SITDOWN, STARTGAME, STATUSMESSAGE, SVPTEXTMSG, TEXTMSG, TIMINGPING, TURN, UPDATEROBOTPARAMS, VERSION

Constructor Summary

SOCLeave(java.lang.String nn, java.lang.String hn, java.lang.String ch)
Create a Leave message.

Method Summary

java.lang.String	getChannel()
java.lang.String	getHost()
java.lang.String	getNickname()
static SOCLeave	parseDataStr(java.lang.String s) Parse the command String into a Leave message
java.lang.String	toCmd() sep sep2 sep2
static java.lang.String	toCmd(java.lang.String nn, java.lang.String hn, java.lang.String ch) sep sep2 sep2
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

nickname

private java.lang.String nickname

Nickname of the leaveing member

channel

private java.lang.String channel

Name of channel

host

private java.lang.String host

Host name

Constructor Detail

SOCLeave

public SOCLeave(java.lang.String nn,
                java.lang.String hn,
                java.lang.String ch)

Create a Leave message.

Parameters:

nn - nickname

hn - host name

ch - name of chat channel

Method Detail

getNickname

public java.lang.String getNickname()

Returns:

the nickname

getHost

public java.lang.String getHost()

Returns:

the host name

getChannel

public java.lang.String getChannel()

Returns:

the channel name

toCmd

public java.lang.String toCmd()

sep sep2 sep2

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

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

sep sep2 sep2

Parameters:

nn - the neckname

hn - the host name

ch - the new channel name

Returns:

the command string

parseDataStr

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

Parse the command String into a Leave message

Parameters:

s - the String to parse

Returns:

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