com.planet_ink.coffee_mud.Libraries
Class CoffeeFilter

java.lang.Object
  extended by com.planet_ink.coffee_mud.Libraries.StdLibrary
      extended by com.planet_ink.coffee_mud.Libraries.CoffeeFilter
All Implemented Interfaces:
CMObject, Tickable, CMLibrary, TelnetFilter, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class CoffeeFilter
extends StdLibrary
implements TelnetFilter


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.TelnetFilter
TelnetFilter.Pronoun
 
Field Summary
 
Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
isDebugging, name, serviceClient, tickStatus
 
Fields inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.TelnetFilter
hexStr
 
Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.Tickable
STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BEAMWEAPON, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET
 
Constructor Summary
CoffeeFilter()
           
 
Method Summary
 java.lang.String colorOnlyFilter(java.lang.String msg, Session S)
           
protected  int convertEscape(Session S, java.lang.StringBuffer str, int index)
           
 java.lang.String fullInFilter(java.lang.String input)
           
 java.lang.String fullOutFilter(Session S, MOB mob, Physical source, Environmental target, Environmental tool, java.lang.String msg, boolean wrapOnly)
           
 java.lang.String getLastWord(java.lang.StringBuffer buf, int lastSp, int lastSpace)
           
 java.util.Map<java.lang.String,TelnetFilter.Pronoun> getTagTable()
           
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 void initializeClass()
          Called ONCE after all objects are loaded, but before the map is read in during initialization.
 java.lang.String mxpSafetyFilter(java.lang.String msg, Session S)
           
 java.lang.String safetyFilter(java.lang.String s)
           
 java.lang.String secondaryUserInputFilter(java.lang.String s)
           
 java.lang.String simpleInFilter(java.lang.StringBuilder input)
           
 java.lang.String simpleInFilter(java.lang.StringBuilder input, boolean permitMXPTags)
           
 java.lang.String simpleOutFilter(java.lang.String msg)
           
 java.lang.String[] wrapOnlyFilter(java.lang.String msg, int wrap)
           
 
Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick
 
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, getServiceClient, L, propertiesLoaded, shutdown
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, name, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

CoffeeFilter

public CoffeeFilter()
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, Tech. 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

initializeClass

public void initializeClass()
Description copied from interface: CMObject
Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:
initializeClass in interface CMObject
Overrides:
initializeClass in class StdLibrary

getTagTable

public java.util.Map<java.lang.String,TelnetFilter.Pronoun> getTagTable()
Specified by:
getTagTable in interface TelnetFilter

simpleOutFilter

public java.lang.String simpleOutFilter(java.lang.String msg)
Specified by:
simpleOutFilter in interface TelnetFilter

wrapOnlyFilter

public java.lang.String[] wrapOnlyFilter(java.lang.String msg,
                                         int wrap)
Specified by:
wrapOnlyFilter in interface TelnetFilter

secondaryUserInputFilter

public java.lang.String secondaryUserInputFilter(java.lang.String s)
Specified by:
secondaryUserInputFilter in interface TelnetFilter

convertEscape

protected int convertEscape(Session S,
                            java.lang.StringBuffer str,
                            int index)

colorOnlyFilter

public java.lang.String colorOnlyFilter(java.lang.String msg,
                                        Session S)
Specified by:
colorOnlyFilter in interface TelnetFilter

mxpSafetyFilter

public java.lang.String mxpSafetyFilter(java.lang.String msg,
                                        Session S)
Specified by:
mxpSafetyFilter in interface TelnetFilter

getLastWord

public java.lang.String getLastWord(java.lang.StringBuffer buf,
                                    int lastSp,
                                    int lastSpace)
Specified by:
getLastWord in interface TelnetFilter

fullOutFilter

public java.lang.String fullOutFilter(Session S,
                                      MOB mob,
                                      Physical source,
                                      Environmental target,
                                      Environmental tool,
                                      java.lang.String msg,
                                      boolean wrapOnly)
Specified by:
fullOutFilter in interface TelnetFilter

simpleInFilter

public java.lang.String simpleInFilter(java.lang.StringBuilder input)
Specified by:
simpleInFilter in interface TelnetFilter

simpleInFilter

public java.lang.String simpleInFilter(java.lang.StringBuilder input,
                                       boolean permitMXPTags)
Specified by:
simpleInFilter in interface TelnetFilter

fullInFilter

public java.lang.String fullInFilter(java.lang.String input)
Specified by:
fullInFilter in interface TelnetFilter

safetyFilter

public java.lang.String safetyFilter(java.lang.String s)
Specified by:
safetyFilter in interface TelnetFilter