soc.message
Class SOCMembers

java.lang.Object
  soc.message.SOCMessage
      soc.message.SOCMembers

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SOCMembers
extends SOCMessage

This message lists all the members of a chat channel

Author:

Robert S Thomas

See Also:

Serialized Form

Field Summary

private java.lang.String	channel Name of channel
private java.util.Vector<java.lang.String>	members List of members
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

SOCMembers(java.lang.String ch, java.util.Vector<java.lang.String> ml)
Create a Members message.

Method Summary

java.lang.String	getChannel()
java.util.Vector<java.lang.String>	getMembers()
static SOCMembers	parseDataStr(java.lang.String s) Parse the command String into a Members message
java.lang.String	toCmd() MEMBERS sep channel sep2 members
static java.lang.String	toCmd(java.lang.String ch, java.util.Vector<?> ml) MEMBERS sep channel sep2 members
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

members

private java.util.Vector<java.lang.String> members

List of members

channel

private java.lang.String channel

Name of channel

Constructor Detail

SOCMembers

public SOCMembers(java.lang.String ch,
                  java.util.Vector<java.lang.String> ml)

Create a Members message.

Parameters:

ch - name of chat channel

ml - list of members

Method Detail

getMembers

public java.util.Vector<java.lang.String> getMembers()

Returns:

the list of members

getChannel

public java.lang.String getChannel()

Returns:

the channel name

toCmd

public java.lang.String toCmd()

MEMBERS sep channel sep2 members

Specified by:

toCmd in class SOCMessage

Returns:

the command String

toCmd

public static java.lang.String toCmd(java.lang.String ch,
                                     java.util.Vector<?> ml)

MEMBERS sep channel sep2 members

Used from instance method toCmd() with Strings, and from other callers with StringConnections for convenience.

Parameters:

ch - the new channel name

ml - the list of members (String or StringConnection)

Returns:

the command string

parseDataStr

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

Parse the command String into a Members message

Parameters:

s - the String to parse

Returns:

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