com.planet_ink.coffee_mud.Libraries
Class MUDPercolator

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

All Implemented Interfaces:

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

public class MUDPercolator
extends StdLibrary
implements AreaGenerationLibrary

Nested Class Summary

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

AreaGenerationLibrary.LayoutFlags, AreaGenerationLibrary.LayoutManager, AreaGenerationLibrary.LayoutNode, AreaGenerationLibrary.LayoutRuns, AreaGenerationLibrary.LayoutTags, AreaGenerationLibrary.LayoutTypes

Constructor Summary

MUDPercolator()

Method Summary

boolean	activate()
protected void	addDefinition(java.lang.String definition, java.lang.String value, java.util.Hashtable defined)
protected Ability	buildAbility(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
Area	buildArea(XMLLibrary.XMLpiece piece, java.util.Hashtable defined, int direction)
protected Behavior	buildBehavior(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
void	buildDefinedIDSet(java.util.List<XMLLibrary.XMLpiece> xmlRoot, java.util.Hashtable defined)
protected Exit	buildExit(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.util.List<Item>	buildItem(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected MOB	buildMob(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
Room	buildRoom(XMLLibrary.XMLpiece piece, java.util.Hashtable defined, Exit[] exits, int direction)
protected void	checkRequirements(java.util.Hashtable defined, java.lang.String requirements)
void	checkRequirements(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected boolean	checkRequirementsValue(java.lang.String validValue, java.lang.String value)
protected java.lang.String	cleanRequirementsValue(java.lang.String values, java.lang.String value)
protected void	defineReward(XMLLibrary.XMLpiece piece, java.lang.String value, java.util.Hashtable defined)
protected void	fillOutStatCodes(Modifiable E, java.lang.String[] ignoreStats, java.lang.String defPrefix, XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected void	fillOutStats(Environmental E, java.lang.String[] ignoreStats, java.lang.String defPrefix, XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.util.Vector	findAbilities(java.lang.String tagName, XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.util.Vector	findAbilities(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.util.Vector	findAffects(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.util.Vector	findBehaviors(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.util.Vector	findContents(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
Exit	findExit(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
java.util.Vector	findExits(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
java.util.Vector	findItems(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
java.util.Vector	findMobs(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.lang.String	findOptionalString(java.lang.String tagName, XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
Room	findRoom(XMLLibrary.XMLpiece piece, java.util.Hashtable defined, Exit[] exits, int directions)
DVector	findRooms(XMLLibrary.XMLpiece piece, java.util.Hashtable defined, Exit[] exits, int direction)
protected java.util.Vector	findShopInventory(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
java.lang.String	findString(java.lang.String tagName, XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
protected java.util.List<XMLLibrary.XMLpiece>	getAllChoices(java.lang.String tagName, XMLLibrary.XMLpiece piece, java.util.Hashtable defined, boolean skipTest)
AreaGenerationLibrary.LayoutManager	getLayoutManager(java.lang.String named)
protected java.lang.String	getRequirementsDescription(java.lang.String values)
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
protected void	layoutFollow(AreaGenerationLibrary.LayoutNode n, AreaGenerationLibrary.LayoutTypes type, int direction, java.util.HashSet<AreaGenerationLibrary.LayoutNode> nodesDone, java.util.List<AreaGenerationLibrary.LayoutNode> group)
protected void	layoutRecursiveFill(AreaGenerationLibrary.LayoutNode n, java.util.HashSet<AreaGenerationLibrary.LayoutNode> nodesDone, java.util.Vector<AreaGenerationLibrary.LayoutNode> group, AreaGenerationLibrary.LayoutTypes type)
void	processRoom(Area A, int direction, XMLLibrary.XMLpiece piece, AreaGenerationLibrary.LayoutNode node, java.util.Hashtable groupDefined)
protected java.util.List<XMLLibrary.XMLpiece>	selectChoices(java.util.List<XMLLibrary.XMLpiece> choices, XMLLibrary.XMLpiece piece, java.util.Hashtable defined)
boolean	shutdown()
protected java.lang.String	strFilter(java.lang.String str, java.util.Hashtable defined)
protected boolean	testCondition(XMLLibrary.XMLpiece piece, java.util.Hashtable defined)

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

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

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

Constructor Detail

MUDPercolator

public MUDPercolator()

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

getLayoutManager

public AreaGenerationLibrary.LayoutManager getLayoutManager(java.lang.String named)

Specified by:

getLayoutManager in interface AreaGenerationLibrary

buildDefinedIDSet

public void buildDefinedIDSet(java.util.List<XMLLibrary.XMLpiece> xmlRoot,
                              java.util.Hashtable defined)

Specified by:

buildDefinedIDSet in interface AreaGenerationLibrary

activate

public boolean activate()

Specified by:

activate in interface CMLibrary

Overrides:

activate in class StdLibrary

shutdown

public boolean shutdown()

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

buildRoom

public Room buildRoom(XMLLibrary.XMLpiece piece,
                      java.util.Hashtable defined,
                      Exit[] exits,
                      int direction)
               throws CMException

Specified by:

buildRoom in interface AreaGenerationLibrary

Throws:

CMException

layoutRecursiveFill

protected void layoutRecursiveFill(AreaGenerationLibrary.LayoutNode n,
                                   java.util.HashSet<AreaGenerationLibrary.LayoutNode> nodesDone,
                                   java.util.Vector<AreaGenerationLibrary.LayoutNode> group,
                                   AreaGenerationLibrary.LayoutTypes type)

layoutFollow

protected void layoutFollow(AreaGenerationLibrary.LayoutNode n,
                            AreaGenerationLibrary.LayoutTypes type,
                            int direction,
                            java.util.HashSet<AreaGenerationLibrary.LayoutNode> nodesDone,
                            java.util.List<AreaGenerationLibrary.LayoutNode> group)

buildArea

public Area buildArea(XMLLibrary.XMLpiece piece,
                      java.util.Hashtable defined,
                      int direction)
               throws CMException

Specified by:

buildArea in interface AreaGenerationLibrary

Throws:

CMException

processRoom

public void processRoom(Area A,
                        int direction,
                        XMLLibrary.XMLpiece piece,
                        AreaGenerationLibrary.LayoutNode node,
                        java.util.Hashtable groupDefined)
                 throws CMException

Throws:

CMException

findMobs

public java.util.Vector findMobs(XMLLibrary.XMLpiece piece,
                                 java.util.Hashtable defined)
                          throws CMException

Specified by:

findMobs in interface AreaGenerationLibrary

Throws:

CMException

findRoom

public Room findRoom(XMLLibrary.XMLpiece piece,
                     java.util.Hashtable defined,
                     Exit[] exits,
                     int directions)
              throws CMException

Throws:

CMException

findRooms

public DVector findRooms(XMLLibrary.XMLpiece piece,
                         java.util.Hashtable defined,
                         Exit[] exits,
                         int direction)
                  throws CMException

Throws:

CMException

findExit

public Exit findExit(XMLLibrary.XMLpiece piece,
                     java.util.Hashtable defined)
              throws CMException

Throws:

CMException

fillOutStatCodes

protected void fillOutStatCodes(Modifiable E,
                                java.lang.String[] ignoreStats,
                                java.lang.String defPrefix,
                                XMLLibrary.XMLpiece piece,
                                java.util.Hashtable defined)

fillOutStats

protected void fillOutStats(Environmental E,
                            java.lang.String[] ignoreStats,
                            java.lang.String defPrefix,
                            XMLLibrary.XMLpiece piece,
                            java.util.Hashtable defined)

buildMob

protected MOB buildMob(XMLLibrary.XMLpiece piece,
                       java.util.Hashtable defined)
                throws CMException

Throws:

CMException

findExits

public java.util.Vector findExits(XMLLibrary.XMLpiece piece,
                                  java.util.Hashtable defined)
                           throws CMException

Throws:

CMException

buildExit

protected Exit buildExit(XMLLibrary.XMLpiece piece,
                         java.util.Hashtable defined)
                  throws CMException

Throws:

CMException

findShopInventory

protected java.util.Vector findShopInventory(XMLLibrary.XMLpiece piece,
                                             java.util.Hashtable defined)
                                      throws CMException

Throws:

CMException

findItems

public java.util.Vector findItems(XMLLibrary.XMLpiece piece,
                                  java.util.Hashtable defined)
                           throws CMException

Specified by:

findItems in interface AreaGenerationLibrary

Throws:

CMException

findContents

protected java.util.Vector findContents(XMLLibrary.XMLpiece piece,
                                        java.util.Hashtable defined)
                                 throws CMException

Throws:

CMException

buildItem

protected java.util.List<Item> buildItem(XMLLibrary.XMLpiece piece,
                                         java.util.Hashtable defined)
                                  throws CMException

Throws:

CMException

findAffects

protected java.util.Vector findAffects(XMLLibrary.XMLpiece piece,
                                       java.util.Hashtable defined)
                                throws CMException

Throws:

CMException

findAbilities

protected java.util.Vector findAbilities(XMLLibrary.XMLpiece piece,
                                         java.util.Hashtable defined)
                                  throws CMException

Throws:

CMException

findAbilities

protected java.util.Vector findAbilities(java.lang.String tagName,
                                         XMLLibrary.XMLpiece piece,
                                         java.util.Hashtable defined)
                                  throws CMException

Throws:

CMException

findBehaviors

protected java.util.Vector findBehaviors(XMLLibrary.XMLpiece piece,
                                         java.util.Hashtable defined)
                                  throws CMException

Throws:

CMException

buildAbility

protected Ability buildAbility(XMLLibrary.XMLpiece piece,
                               java.util.Hashtable defined)
                        throws CMException

Throws:

CMException

buildBehavior

protected Behavior buildBehavior(XMLLibrary.XMLpiece piece,
                                 java.util.Hashtable defined)
                          throws CMException

Throws:

CMException

addDefinition

protected void addDefinition(java.lang.String definition,
                             java.lang.String value,
                             java.util.Hashtable defined)

findOptionalString

protected java.lang.String findOptionalString(java.lang.String tagName,
                                              XMLLibrary.XMLpiece piece,
                                              java.util.Hashtable defined)

defineReward

protected void defineReward(XMLLibrary.XMLpiece piece,
                            java.lang.String value,
                            java.util.Hashtable defined)
                     throws CMException

Throws:

CMException

findString

public java.lang.String findString(java.lang.String tagName,
                                   XMLLibrary.XMLpiece piece,
                                   java.util.Hashtable defined)
                            throws CMException

Specified by:

findString in interface AreaGenerationLibrary

Throws:

CMException

getAllChoices

protected java.util.List<XMLLibrary.XMLpiece> getAllChoices(java.lang.String tagName,
                                                            XMLLibrary.XMLpiece piece,
                                                            java.util.Hashtable defined,
                                                            boolean skipTest)
                                                     throws CMException

Throws:

CMException

testCondition

protected boolean testCondition(XMLLibrary.XMLpiece piece,
                                java.util.Hashtable defined)

getRequirementsDescription

protected java.lang.String getRequirementsDescription(java.lang.String values)

checkRequirementsValue

protected boolean checkRequirementsValue(java.lang.String validValue,
                                         java.lang.String value)

cleanRequirementsValue

protected java.lang.String cleanRequirementsValue(java.lang.String values,
                                                  java.lang.String value)

checkRequirements

protected void checkRequirements(java.util.Hashtable defined,
                                 java.lang.String requirements)
                          throws CMException

Throws:

CMException

checkRequirements

public void checkRequirements(XMLLibrary.XMLpiece piece,
                              java.util.Hashtable defined)
                       throws CMException

Specified by:

checkRequirements in interface AreaGenerationLibrary

Throws:

CMException

selectChoices

protected java.util.List<XMLLibrary.XMLpiece> selectChoices(java.util.List<XMLLibrary.XMLpiece> choices,
                                                            XMLLibrary.XMLpiece piece,
                                                            java.util.Hashtable defined)
                                                     throws CMException

Throws:

CMException

strFilter

protected java.lang.String strFilter(java.lang.String str,
                                     java.util.Hashtable defined)
                              throws CMException

Throws:

CMException