com.planet_ink.coffee_mud.WebMacros
Class RoomData

java.lang.Object
  com.planet_ink.coffee_mud.WebMacros.StdWebMacro
      com.planet_ink.coffee_mud.WebMacros.RoomData

All Implemented Interfaces:

CMObject, WebMacro, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class RoomData
extends StdWebMacro

Constructor Summary

RoomData()

Method Summary

static java.util.List<Item>	contributeItems(java.util.List<Item> inhabs)
static java.util.List<MOB>	contributeMOBs(java.util.List<MOB> inhabs)
static Pair<java.lang.String,java.lang.String>	findPair(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures, java.lang.String varStart, java.lang.String value)
static java.util.List<Pair<java.lang.String,java.lang.String>>	findPairs(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures, java.lang.String varStart, java.lang.String value)
static java.lang.String	getAppropriateCode(Environmental E, Environmental RorM, java.util.List classes, java.util.List list)
static java.util.List<Item>	getItemCache()
static java.lang.String	getItemCode(java.util.List<Item> allitems, Item I)
static java.lang.String	getItemCode(MOB M, Item I)
static java.lang.String	getItemCode(Room R, Item I)
static Item	getItemFromAnywhere(java.lang.Object allitems, java.lang.String MATCHING)
static Item	getItemFromCatalog(java.lang.String MATCHING)
static Item	getItemFromCode(java.util.List<Item> allitems, java.lang.String code)
static Item	getItemFromCode(MOB M, java.lang.String code)
static Item	getItemFromCode(Room R, java.lang.String code)
static java.util.List<MOB>	getMOBCache()
static java.lang.String	getMOBCode(java.util.List<MOB> mobs, MOB M)
static java.lang.String	getMOBCode(Room R, MOB M)
static MOB	getMOBFromCatalog(java.lang.String MATCHING)
static MOB	getMOBFromCode(java.util.List<MOB> allmobs, java.lang.String code)
static MOB	getMOBFromCode(Room R, java.lang.String code)
static int	getNumFromWordNum(java.lang.String var)
static java.lang.String	getObjIDSuffix(Environmental E)
static Pair<java.lang.String,java.lang.String>	getPair(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures, java.lang.String var)
static java.lang.String	getPairValue(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures, java.lang.String var)
static Item	getReferenceItem(Item I)
static MOB	getReferenceMOB(MOB M)
static boolean	isAllNum(java.lang.String str)
static Pair<java.lang.String,java.lang.String>[]	makeMergableRoomFields(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, Room R, java.util.List<java.lang.String> multiRoomList)
static Pair<java.lang.String,java.lang.String>[]	makePairs(com.planet_ink.coffee_mud.WebMacros.RoomData.RoomStuff stuff, java.util.List<Pair<java.lang.String,java.lang.String>> fixtures)
com.planet_ink.coffee_mud.WebMacros.RoomData.RoomStuff	makeRoomStuff(Room R, java.util.List<Pair<java.lang.String,java.lang.String>> fixtures)
static void	mergeRoomField(java.util.List<Pair<java.lang.String,java.lang.String>> currentRoomPairsList, java.util.List<Pair<java.lang.String,java.lang.String>> commonRoomsPairsList, java.util.List<Pair<java.lang.String,java.lang.String>> submittedRoomPairsList, java.lang.String[] vars)
static com.planet_ink.coffee_web.interfaces.HTTPRequest	mergeRoomFields(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, Pair<java.lang.String,java.lang.String>[] setPairs, Room R)
java.lang.String	name() The public name of this macro
java.lang.String	runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String parm, com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp) This method is executed only if this macro returns false for preferBinary().
static java.util.List<Pair<java.lang.String,java.lang.String>>	toPairs(java.util.Map<java.lang.String,java.lang.String> map)

Methods inherited from class com.planet_ink.coffee_mud.WebMacros.StdWebMacro

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getHTTPFileData, grabFile, helpHelp, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAdminMacro, isAWebPath, L, newInstance, parseOrderedParms, parseParms, parseParms, preferBinary, runBinaryMacro, safeIncomingfilter, webify

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomData

public RoomData()

Method Detail

name

public java.lang.String name()

Description copied from interface: WebMacro

The public name of this macro

Specified by:

name in interface CMObject

Specified by:

name in interface WebMacro

Overrides:

name in class StdWebMacro

Returns:

The public name of this macro

See Also:

Environmental.Name()

getMOBCache

public static java.util.List<MOB> getMOBCache()

getItemCache

public static java.util.List<Item> getItemCache()

getItemCode

public static java.lang.String getItemCode(Room R,
                                           Item I)

getItemCode

public static java.lang.String getItemCode(java.util.List<Item> allitems,
                                           Item I)

getItemCode

public static java.lang.String getItemCode(MOB M,
                                           Item I)

getMOBCode

public static java.lang.String getMOBCode(Room R,
                                          MOB M)

getMOBCode

public static java.lang.String getMOBCode(java.util.List<MOB> mobs,
                                          MOB M)

getItemFromCode

public static Item getItemFromCode(MOB M,
                                   java.lang.String code)

getItemFromCode

public static Item getItemFromCode(Room R,
                                   java.lang.String code)

getItemFromCode

public static Item getItemFromCode(java.util.List<Item> allitems,
                                   java.lang.String code)

getMOBFromCode

public static MOB getMOBFromCode(Room R,
                                 java.lang.String code)

getMOBFromCode

public static MOB getMOBFromCode(java.util.List<MOB> allmobs,
                                 java.lang.String code)

getMOBFromCatalog

public static MOB getMOBFromCatalog(java.lang.String MATCHING)

getItemFromCatalog

public static Item getItemFromCatalog(java.lang.String MATCHING)

getAppropriateCode

public static java.lang.String getAppropriateCode(Environmental E,
                                                  Environmental RorM,
                                                  java.util.List classes,
                                                  java.util.List list)

getItemFromAnywhere

public static Item getItemFromAnywhere(java.lang.Object allitems,
                                       java.lang.String MATCHING)

getReferenceMOB

public static MOB getReferenceMOB(MOB M)

getReferenceItem

public static Item getReferenceItem(Item I)

contributeMOBs

public static java.util.List<MOB> contributeMOBs(java.util.List<MOB> inhabs)

isAllNum

public static boolean isAllNum(java.lang.String str)

contributeItems

public static java.util.List<Item> contributeItems(java.util.List<Item> inhabs)

getObjIDSuffix

public static final java.lang.String getObjIDSuffix(Environmental E)

getNumFromWordNum

public static int getNumFromWordNum(java.lang.String var)

findPair

public static Pair<java.lang.String,java.lang.String> findPair(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures,
                                                               java.lang.String varStart,
                                                               java.lang.String value)

findPairs

public static java.util.List<Pair<java.lang.String,java.lang.String>> findPairs(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures,
                                                                                java.lang.String varStart,
                                                                                java.lang.String value)

getPair

public static Pair<java.lang.String,java.lang.String> getPair(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures,
                                                              java.lang.String var)

getPairValue

public static java.lang.String getPairValue(java.util.List<Pair<java.lang.String,java.lang.String>> fixtures,
                                            java.lang.String var)

toPairs

public static java.util.List<Pair<java.lang.String,java.lang.String>> toPairs(java.util.Map<java.lang.String,java.lang.String> map)

makeRoomStuff

public com.planet_ink.coffee_mud.WebMacros.RoomData.RoomStuff makeRoomStuff(Room R,
                                                                            java.util.List<Pair<java.lang.String,java.lang.String>> fixtures)

makePairs

public static Pair<java.lang.String,java.lang.String>[] makePairs(com.planet_ink.coffee_mud.WebMacros.RoomData.RoomStuff stuff,
                                                                  java.util.List<Pair<java.lang.String,java.lang.String>> fixtures)

makeMergableRoomFields

public static Pair<java.lang.String,java.lang.String>[] makeMergableRoomFields(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                                                               Room R,
                                                                               java.util.List<java.lang.String> multiRoomList)

mergeRoomField

public static void mergeRoomField(java.util.List<Pair<java.lang.String,java.lang.String>> currentRoomPairsList,
                                  java.util.List<Pair<java.lang.String,java.lang.String>> commonRoomsPairsList,
                                  java.util.List<Pair<java.lang.String,java.lang.String>> submittedRoomPairsList,
                                  java.lang.String[] vars)

mergeRoomFields

public static com.planet_ink.coffee_web.interfaces.HTTPRequest mergeRoomFields(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                                                               Pair<java.lang.String,java.lang.String>[] setPairs,
                                                                               Room R)

runMacro

public java.lang.String runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                 java.lang.String parm,
                                 com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)

Description copied from interface: WebMacro

This method is executed only if this macro returns false for preferBinary(). It will execute the macro and return its results as a string, which is then substituted for the macro reference in the web page where the macro was found. The response object is used to set cookies and headers only. Any response body is in the return object. Since 99% of macros are only filling in an existing page, nothing will be done with that anyway, and is only important when isAWebPath return true.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strings given to the macro

httpResp - the response, with headers

Returns:

the string result of running this macro

See Also:

WebMacro.preferBinary(), HTTPRequest