JSettlers v1.0.6 API
Built ${date}

soc.message
Class SOCChannels

java.lang.Object
  extended bysoc.message.SOCMessage
      extended bysoc.message.SOCChannels
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class SOCChannels
extends SOCMessage

This message lists all the chat channels on a server

Author:
Robert S Thomas
See Also:
Serialized Form

Field Summary
 
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, RESOURCECOUNT, ROBOTDISMISS, ROLLDICE, ROLLDICEREQUEST, sep, sep2, SERVERPING, SETPLAYEDDEVCARD, SETSEATLOCK, SETTURN, SETUPDONE, SITDOWN, STARTGAME, STATUSMESSAGE, TEXTMSG, TURN, UPDATEROBOTPARAMS
 
Constructor Summary
SOCChannels(java.util.Vector cl)
          Create a Channels Message.
 
Method Summary
 java.util.Vector getChannels()
           
static SOCChannels parseDataStr(java.lang.String s)
          Parse the command String into a Channels message
 java.lang.String toCmd()
          CHANNELS sep channels
static java.lang.String toCmd(java.util.Vector cl)
          CHANNELS sep channels
 java.lang.String toString()
           
 
Methods inherited from class soc.message.SOCMessage
getType, toMsg
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SOCChannels

public SOCChannels(java.util.Vector cl)
Create a Channels Message.

Parameters:
cl - list of channels
Method Detail

getChannels

public java.util.Vector getChannels()
Returns:
the list of channels

toCmd

public java.lang.String toCmd()
CHANNELS sep channels

Specified by:
toCmd in class SOCMessage
Returns:
the command String

toCmd

public static java.lang.String toCmd(java.util.Vector cl)
CHANNELS sep channels

Parameters:
cl - the list of channels
Returns:
the command string

parseDataStr

public static SOCChannels parseDataStr(java.lang.String s)
Parse the command String into a Channels message

Parameters:
s - the String to parse
Returns:
a Channels message, or null of the data is garbled

toString

public java.lang.String toString()
Returns:
a human readable form of the message

JSettlers v1.0.6 API
Built ${date}