com.planet_ink.coffee_mud.Libraries
Class CMChannels

java.lang.Object
  com.planet_ink.coffee_mud.Libraries.StdLibrary
      com.planet_ink.coffee_mud.Libraries.CMChannels

All Implemented Interfaces:

CMObject, ChannelsLibrary, CMLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class CMChannels
extends StdLibrary
implements ChannelsLibrary

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.ChannelsLibrary

ChannelsLibrary.ChannelFlag

Field Summary

java.util.Vector<java.util.HashSet<ChannelsLibrary.ChannelFlag>>	channelFlags
java.util.Vector	channelMasks
java.util.Vector	channelNames
java.util.Vector	channelQue
java.util.HashSet<ChannelsLibrary.ChannelFlag>	emptyFlags
java.util.Vector	ichannelList
java.util.Vector	imc2channelList
int	numChannelsLoaded
int	numIChannelsLoaded
int	numImc2ChannelsLoaded
int	QUEUE_SIZE

Constructor Summary

CMChannels()

Method Summary

void	channelQueUp(int i, CMMsg msg)
boolean	channelTo(Session ses, boolean areareq, int channelInt, CMMsg msg, MOB sender)
java.util.List<Session>	clearInvalidSnoopers(Session mySession, int channelCode)
int	getChannelCodeNumber(java.lang.String channelName)
java.util.HashSet<ChannelsLibrary.ChannelFlag>	getChannelFlags(int i)
int	getChannelIndex(java.lang.String channelName)
java.lang.String	getChannelMask(int i)
java.lang.String	getChannelName(int i)
java.lang.String	getChannelName(java.lang.String channelName)
java.lang.String[]	getChannelNames()
java.util.List<CMMsg>	getChannelQue(int i)
java.lang.String	getExtraChannelDesc(java.lang.String channelName)
java.util.List<java.lang.String>	getFlaggedChannelNames(ChannelsLibrary.ChannelFlag flag)
int	getNumChannels()
java.lang.String[][]	iChannelsArray()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
java.lang.String[][]	imc2ChannelsArray()
int	loadChannels(java.lang.String list, java.lang.String ilist, java.lang.String imc2list)
boolean	mayReadThisChannel(MOB sender, boolean areaReq, MOB M, int i)
boolean	mayReadThisChannel(MOB sender, boolean areaReq, MOB M, int i, boolean offlineOK)
boolean	mayReadThisChannel(MOB sender, boolean areaReq, Session ses, int i)
boolean	mayReadThisChannel(MOB M, int i, boolean zapCheckOnly)
java.lang.String	parseOutFlags(java.lang.String mask, java.util.HashSet<ChannelsLibrary.ChannelFlag> flags)
void	reallyChannel(MOB mob, java.lang.String channelName, java.lang.String message, boolean systemMsg)
void	restoreInvalidSnoopers(Session mySession, java.util.List<Session> invalid)
boolean	shutdown()

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, compareTo, copyOf, getSupportThread, initializeClass, newInstance, propertiesLoaded

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getSupportThread, propertiesLoaded

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

QUEUE_SIZE

public final int QUEUE_SIZE

See Also:

Constant Field Values

numChannelsLoaded

public int numChannelsLoaded

numIChannelsLoaded

public int numIChannelsLoaded

numImc2ChannelsLoaded

public int numImc2ChannelsLoaded

channelNames

public java.util.Vector channelNames

channelMasks

public java.util.Vector channelMasks

channelFlags

public java.util.Vector<java.util.HashSet<ChannelsLibrary.ChannelFlag>> channelFlags

ichannelList

public java.util.Vector ichannelList

imc2channelList

public java.util.Vector imc2channelList

channelQue

public java.util.Vector channelQue

emptyFlags

public final java.util.HashSet<ChannelsLibrary.ChannelFlag> emptyFlags

Constructor Detail

CMChannels

public CMChannels()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

getNumChannels

public int getNumChannels()

Specified by:

getNumChannels in interface ChannelsLibrary

getChannelMask

public java.lang.String getChannelMask(int i)

Specified by:

getChannelMask in interface ChannelsLibrary

getChannelFlags

public java.util.HashSet<ChannelsLibrary.ChannelFlag> getChannelFlags(int i)

Specified by:

getChannelFlags in interface ChannelsLibrary

getChannelName

public java.lang.String getChannelName(int i)

Specified by:

getChannelName in interface ChannelsLibrary

getChannelQue

public java.util.List<CMMsg> getChannelQue(int i)

Specified by:

getChannelQue in interface ChannelsLibrary

mayReadThisChannel

public boolean mayReadThisChannel(MOB sender,
                                  boolean areaReq,
                                  MOB M,
                                  int i)

Specified by:

mayReadThisChannel in interface ChannelsLibrary

mayReadThisChannel

public boolean mayReadThisChannel(MOB sender,
                                  boolean areaReq,
                                  MOB M,
                                  int i,
                                  boolean offlineOK)

Specified by:

mayReadThisChannel in interface ChannelsLibrary

mayReadThisChannel

public boolean mayReadThisChannel(MOB sender,
                                  boolean areaReq,
                                  Session ses,
                                  int i)

Specified by:

mayReadThisChannel in interface ChannelsLibrary

mayReadThisChannel

public boolean mayReadThisChannel(MOB M,
                                  int i,
                                  boolean zapCheckOnly)

Specified by:

mayReadThisChannel in interface ChannelsLibrary

channelQueUp

public void channelQueUp(int i,
                         CMMsg msg)

Specified by:

channelQueUp in interface ChannelsLibrary

getChannelIndex

public int getChannelIndex(java.lang.String channelName)

Specified by:

getChannelIndex in interface ChannelsLibrary

getChannelCodeNumber

public int getChannelCodeNumber(java.lang.String channelName)

Specified by:

getChannelCodeNumber in interface ChannelsLibrary

getChannelName

public java.lang.String getChannelName(java.lang.String channelName)

Specified by:

getChannelName in interface ChannelsLibrary

getFlaggedChannelNames

public java.util.List<java.lang.String> getFlaggedChannelNames(ChannelsLibrary.ChannelFlag flag)

Specified by:

getFlaggedChannelNames in interface ChannelsLibrary

getExtraChannelDesc

public java.lang.String getExtraChannelDesc(java.lang.String channelName)

Specified by:

getExtraChannelDesc in interface ChannelsLibrary

shutdown

public boolean shutdown()

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

imc2ChannelsArray

public java.lang.String[][] imc2ChannelsArray()

Specified by:

imc2ChannelsArray in interface ChannelsLibrary

iChannelsArray

public java.lang.String[][] iChannelsArray()

Specified by:

iChannelsArray in interface ChannelsLibrary

getChannelNames

public java.lang.String[] getChannelNames()

Specified by:

getChannelNames in interface ChannelsLibrary

clearInvalidSnoopers

public java.util.List<Session> clearInvalidSnoopers(Session mySession,
                                                    int channelCode)

Specified by:

clearInvalidSnoopers in interface ChannelsLibrary

restoreInvalidSnoopers

public void restoreInvalidSnoopers(Session mySession,
                                   java.util.List<Session> invalid)

Specified by:

restoreInvalidSnoopers in interface ChannelsLibrary

parseOutFlags

public java.lang.String parseOutFlags(java.lang.String mask,
                                      java.util.HashSet<ChannelsLibrary.ChannelFlag> flags)

Specified by:

parseOutFlags in interface ChannelsLibrary

loadChannels

public int loadChannels(java.lang.String list,
                        java.lang.String ilist,
                        java.lang.String imc2list)

Specified by:

loadChannels in interface ChannelsLibrary

channelTo

public boolean channelTo(Session ses,
                         boolean areareq,
                         int channelInt,
                         CMMsg msg,
                         MOB sender)

Specified by:

channelTo in interface ChannelsLibrary

reallyChannel

public void reallyChannel(MOB mob,
                          java.lang.String channelName,
                          java.lang.String message,
                          boolean systemMsg)

Specified by:

reallyChannel in interface ChannelsLibrary