Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface WebMacroLibrary

All Superinterfaces:

java.lang.Cloneable, CMLibrary, CMObject, java.lang.Comparable<CMObject>, com.planet_ink.coffee_web.interfaces.HTTPOutputConverter

All Known Implementing Classes:

WebMacroCreamer

public interface WebMacroLibrary
extends CMLibrary, com.planet_ink.coffee_web.interfaces.HTTPOutputConverter

A helper library for the web server that implements the CMVP pages by interfacing with the web macro system, whereby the web server gains access to the rest of the mud runtime. Most of the methods are helpers also for the macros themselves, providing object caching both short and longer term.

Field Summary

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

idConverter

Method Summary

Modifier and Type	Method	Description
java.lang.String	clearWebMacros(java.lang.String s)	Searches for web-macro commands in the given string and, if found, disables them and returns the modified string.
java.lang.String	clearWebMacros(java.lang.StringBuffer s)	Searches for web-macro commands in the given string and, if found, disables them and returns the modified string.
java.util.Collection<Item>	contributeItemsToWebCache(java.util.Collection<Item> items)	Adds the given items to the web cache, if each one qualifies to be so added.
java.util.Collection<MOB>	contributeMOBsToWebCache(java.util.Collection<MOB> inhabs)	Adds the given mobs to the web cache, if each one qualifies to be so added.
Item	findItemInAnything(java.lang.Object allitems, java.lang.String MATCHING)	Given some sort of item-finding code, including catalog codes, item class ids, catalog codes, web cache codes, and general canonical java class names, this will return the best item match it can find.
Item	findItemInWebCache(java.lang.String MATCHING)	Given some sort of item-finding code, including catalog codes, item class ids, catalog codes, web cache codes, and general canonical java class names, this will return the best item match it can find.
Item	findItemMatchInWebCache(Item I)	Searches the official item web cache for an item just like the one given and, if found, returns the cache object.
java.lang.String	findItemWebCacheCode(Item I)	Searches the official item web cache for this item, or one just like it, and returns the code for it.
java.lang.String	findItemWebCacheCode(Room R, Item I)	Given an item and its room owner, this will return the item web cache code for the item.
java.lang.String	findItemWebCacheCode(MOB M, Item I)	Given an item and its mob owner, this will return the item web cache code for the item.
java.lang.String	findItemWebCacheCode(java.util.Collection<Item> allitems, Item I)	Searches the given item web cache for this item, or one just like it, and returns the code for it.
MOB	findMOBMatchInWebCache(MOB M)	Searches the official web cache for a mob like the given one, and returns it if found.
java.lang.String	findMOBWebCacheCode(Room R, MOB M)	Returns the room-context cache code for the given mob, if it is really in the room.
java.lang.String	findMOBWebCacheCode(MOB M)	Searches for a mob in the web cache that is just like the given mob, and returns the cache code.
java.lang.String	findMOBWebCacheCode(java.util.Collection<MOB> mobs, MOB M)	Given your own mob cache, this will find the mob just like the given one and return its code.
java.lang.String	getAppropriateCode(PhysicalAgent E, Physical RorM, java.util.Collection<? extends Physical> classes)	Given an item or mob, this will attempt to find its like or match in the catalog, web caches, or the given item owner, or given web cache.
Item	getItemFromCatalog(java.lang.String MATCHING)	Searches the catalog for the item with the matching catalog code and, if found, returns it.
Item	getItemFromWebCache(Room R, java.lang.String code)	Give a room item owner, and the item web cache code, this will attempt to return the matching item.
Item	getItemFromWebCache(MOB M, java.lang.String code)	Give a mob item owner, and the item web cache code, this will attempt to return the matching item.
Item	getItemFromWebCache(java.lang.String code)	Searches the catalog and official item web cache for the item with the given code and, if found, returns it.
Item	getItemFromWebCache(java.util.Collection<Item> allitems, java.lang.String code)	Searches the catalog and given item web cache for the item with the given code and, if found, returns it.
java.lang.Iterable<Item>	getItemWebCacheIterable()	Returns an iterable of the item web cache.
MOB	getMOBFromAnywhere(java.lang.String MATCHING)	Given some sort of mob-finding code, including catalog codes, mob class ids, catalog codes, web cache codes, and general canonical java class names, this will return the best mob match it can find.
MOB	getMOBFromCatalog(java.lang.String MATCHING)	If the given mob cache code is a catalog code, this will return the mob from the catalog, if found.
MOB	getMOBFromWebCache(Room R, java.lang.String code)	Finds the mob in the given room with the given web cache code and returns the mob object from the cache.
MOB	getMOBFromWebCache(java.lang.String code)	Searches the official mob web cache for the mob of the given code, which might be a catalog code also.
MOB	getMOBFromWebCache(java.util.Collection<MOB> allmobs, java.lang.String code)	Searches the given mob web cache for the mob of the given code, which might be a catalog code also.
java.lang.Iterable<MOB>	getMOBWebCacheIterable()	Returns an iterator through the mob web cache.
java.lang.String	getWebCacheSuffix(Environmental E)	Checks the expiration date of the given object, which must be something from one of the web caches, as those are the types that have their expiration date used FOR the cache.
boolean	isAllNum(java.lang.String str)	Returns whether the given string resembles a web cache code, which consists of digits and dashes.
boolean	isWebCachedItem(java.lang.Object I)	Returns whether the given item is exactly in the official item web cache.
boolean	isWebCachedMOB(java.lang.Object M)	Returns whether the given mob is in the web cache.
java.lang.String	parseFoundMacro(java.lang.StringBuffer s, int i, boolean lookOnly)	Given a stringbuffer and an index into it where an '@' sign was found, this method will identify a potential web macro string, and return it, optionally deleting the '@' characters on internal macros.
byte[]	virtualPageFilter(byte[] data)	Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.
java.lang.StringBuffer	virtualPageFilter(com.planet_ink.coffee_web.interfaces.HTTPRequest request, java.util.Map<java.lang.String,java.lang.Object> objects, long[] processStartTime, java.lang.String[] lastFoundMacro, java.lang.StringBuffer data)	The official web page filtering method for this output converter.
java.lang.String	virtualPageFilter(java.lang.String data)	Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.
java.lang.StringBuffer	virtualPageFilter(java.lang.StringBuffer data)	Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.
java.lang.StringBuffer	virtualPageFilter(java.lang.StringBuffer data, java.util.Map<java.lang.String,java.lang.String> parms, java.util.Map<java.lang.String,java.lang.Object> objs)	Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.

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, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_web.interfaces.HTTPOutputConverter

convertOutput

Method Detail

virtualPageFilter

byte[] virtualPageFilter(byte[] data)
                  throws HTTPRedirectException

Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.

Parameters:

data - the fake page to filter

Returns:

the filtered page data

Throws:

HTTPRedirectException - any redirect exceptions encountered

See Also:

virtualPageFilter(String), virtualPageFilter(StringBuffer), virtualPageFilter(StringBuffer, Map, Map), virtualPageFilter(HTTPRequest, Map, long[], String[], StringBuffer)

virtualPageFilter

java.lang.String virtualPageFilter(java.lang.String data)
                            throws HTTPRedirectException

Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.

Parameters:

data - the fake page to filter

Returns:

the filtered page data

Throws:

HTTPRedirectException - any redirect exceptions encountered

See Also:

virtualPageFilter(byte[]), virtualPageFilter(StringBuffer), virtualPageFilter(StringBuffer, Map, Map), virtualPageFilter(HTTPRequest, Map, long[], String[], StringBuffer)

virtualPageFilter

java.lang.StringBuffer virtualPageFilter(java.lang.StringBuffer data)
                                  throws HTTPRedirectException

Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.

Parameters:

data - the fake page to filter

Returns:

the filtered page data

Throws:

HTTPRedirectException - any redirect exceptions encountered

See Also:

virtualPageFilter(byte[]), virtualPageFilter(String), virtualPageFilter(StringBuffer, Map, Map), virtualPageFilter(HTTPRequest, Map, long[], String[], StringBuffer)

virtualPageFilter

java.lang.StringBuffer virtualPageFilter(java.lang.StringBuffer data,
                                         java.util.Map<java.lang.String,java.lang.String> parms,
                                         java.util.Map<java.lang.String,java.lang.Object> objs)
                                  throws HTTPRedirectException

Does macro filtering on a fake web page by constructing a fake request and calling the full page filter method.

Parameters:

data - the fake page to filter

parms - fake request parameters, which normally come from the request object

objs - the object cache for use by macros

Returns:

the filtered page data

Throws:

HTTPRedirectException - any redirect exceptions encountered

See Also:

virtualPageFilter(byte[]), virtualPageFilter(String), virtualPageFilter(StringBuffer), virtualPageFilter(HTTPRequest, Map, long[], String[], StringBuffer)

virtualPageFilter

java.lang.StringBuffer virtualPageFilter(com.planet_ink.coffee_web.interfaces.HTTPRequest request,
                                         java.util.Map<java.lang.String,java.lang.Object> objects,
                                         long[] processStartTime,
                                         java.lang.String[] lastFoundMacro,
                                         java.lang.StringBuffer data)
                                  throws HTTPRedirectException

The official web page filtering method for this output converter. Does all the macro conversions and so forth.

Parameters:

request - the web request that was made

objects - an empty 'sessions' object map for use by macros as a cache

processStartTime - a 1-dimensional array with start time-ms, for timeouts

lastFoundMacro - a 1-dimensional array for storing the last found macro

data - the page data, which will be modified and returned by the filter

Returns:

the modified and filtered page data

Throws:

HTTPRedirectException - an http redirect exception found

See Also:

virtualPageFilter(byte[]), virtualPageFilter(String), virtualPageFilter(StringBuffer), virtualPageFilter(StringBuffer, Map, Map)

clearWebMacros

java.lang.String clearWebMacros(java.lang.StringBuffer s)

Searches for web-macro commands in the given string and, if found, disables them and returns the modified string.

Parameters:

s - the string to clear or web

Returns:

the modified and cleared string

parseFoundMacro

java.lang.String parseFoundMacro(java.lang.StringBuffer s,
                                 int i,
                                 boolean lookOnly)

Given a stringbuffer and an index into it where an '@' sign was found, this method will identify a potential web macro string, and return it, optionally deleting the '@' characters on internal macros.

Parameters:

s - the stringbuffer to match a webmacro in

i - the index to start looking at

lookOnly - FALSE to clear '@' on internal macros

Returns:

the found web macro

clearWebMacros

java.lang.String clearWebMacros(java.lang.String s)

Searches for web-macro commands in the given string and, if found, disables them and returns the modified string.

Parameters:

s - the string to clear or web

Returns:

the modified and cleared string

isAllNum

boolean isAllNum(java.lang.String str)

Returns whether the given string resembles a web cache code, which consists of digits and dashes.

Parameters:

str - the string to check

Returns:

true if it resembles a web cache code

getWebCacheSuffix

java.lang.String getWebCacheSuffix(Environmental E)

Checks the expiration date of the given object, which must be something from one of the web caches, as those are the types that have their expiration date used FOR the cache. It then returns a friendly description of that expiration.

Parameters:

E - the mob or item to get an expiration description for

Returns:

an expiration description

getAppropriateCode

java.lang.String getAppropriateCode(PhysicalAgent E,
                                    Physical RorM,
                                    java.util.Collection<? extends Physical> classes)

Given an item or mob, this will attempt to find its like or match in the catalog, web caches, or the given item owner, or given web cache.

Parameters:

E - the object to get a code for

RorM - an item owner

classes - a web cache

Returns:

the appropriate code for the object

contributeItemsToWebCache

java.util.Collection<Item> contributeItemsToWebCache(java.util.Collection<Item> items)

Adds the given items to the web cache, if each one qualifies to be so added.

Parameters:

items - the collection of items to submit

Returns:

the item web cache again

See Also:

findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

findItemMatchInWebCache

Item findItemMatchInWebCache(Item I)

Searches the official item web cache for an item just like the one given and, if found, returns the cache object.

Parameters:

I - the item to look for like

Returns:

the item from the cache, or null

See Also:

contributeItemsToWebCache(Collection), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

findItemInWebCache

Item findItemInWebCache(java.lang.String MATCHING)

Given some sort of item-finding code, including catalog codes, item class ids, catalog codes, web cache codes, and general canonical java class names, this will return the best item match it can find.

Parameters:

MATCHING - the item code to look for

Returns:

the item, if found

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

findItemInAnything

Item findItemInAnything(java.lang.Object allitems,
                        java.lang.String MATCHING)

Given some sort of item-finding code, including catalog codes, item class ids, catalog codes, web cache codes, and general canonical java class names, this will return the best item match it can find.

Parameters:

allitems - a mob, a room, or an item cache, or null

MATCHING - the item code to look for

Returns:

the item, if found

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

getItemFromCatalog

Item getItemFromCatalog(java.lang.String MATCHING)

Searches the catalog for the item with the matching catalog code and, if found, returns it.

Parameters:

MATCHING - the catalog item code

Returns:

null, or the item

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

getItemFromWebCache

Item getItemFromWebCache(java.util.Collection<Item> allitems,
                         java.lang.String code)

Searches the catalog and given item web cache for the item with the given code and, if found, returns it.

Parameters:

code - the item web cache code, or catalog code

allitems - the item web cache to use

Returns:

null, or the item

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

getItemFromWebCache

Item getItemFromWebCache(java.lang.String code)

Searches the catalog and official item web cache for the item with the given code and, if found, returns it.

Parameters:

code - the item web cache code, or catalog code

Returns:

null, or the item

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

getItemFromWebCache

Item getItemFromWebCache(Room R,
                         java.lang.String code)

Give a room item owner, and the item web cache code, this will attempt to return the matching item. Also supports catalog items.

Parameters:

R - the room item owner

code - the item code

Returns:

null, or the item

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

getItemFromWebCache

Item getItemFromWebCache(MOB M,
                         java.lang.String code)

Give a mob item owner, and the item web cache code, this will attempt to return the matching item. Also supports shopkeepers, and catalog items.

Parameters:

M - the mob item owner

code - the item code

Returns:

null, or the item

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

findItemWebCacheCode

java.lang.String findItemWebCacheCode(MOB M,
                                      Item I)

Given an item and its mob owner, this will return the item web cache code for the item.

Parameters:

M - the mob to find the item in

I - the item to get a code for

Returns:

the item web cache code

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

findItemWebCacheCode

java.lang.String findItemWebCacheCode(java.util.Collection<Item> allitems,
                                      Item I)

Searches the given item web cache for this item, or one just like it, and returns the code for it.

Parameters:

I - the item to find like

allitems - the web item cache to use

Returns:

"", or the item web cache code

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

findItemWebCacheCode

java.lang.String findItemWebCacheCode(Item I)

Searches the official item web cache for this item, or one just like it, and returns the code for it.

Parameters:

I - the item to find like

Returns:

"", or the item web cache code

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object), getItemWebCacheIterable()

findItemWebCacheCode

java.lang.String findItemWebCacheCode(Room R,
                                      Item I)

Given an item and its room owner, this will return the item web cache code for the item.

Parameters:

R - the room to find the item in

I - the item to get a code for

Returns:

the item web cache code

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), isWebCachedItem(Object), getItemWebCacheIterable()

isWebCachedItem

boolean isWebCachedItem(java.lang.Object I)

Returns whether the given item is exactly in the official item web cache.

Parameters:

I - the item to look for

Returns:

true if that item object is in the cache

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), getItemWebCacheIterable()

getItemWebCacheIterable

java.lang.Iterable<Item> getItemWebCacheIterable()

Returns an iterable of the item web cache.

Returns:

an iterable of the item web cache.

See Also:

contributeItemsToWebCache(Collection), findItemMatchInWebCache(Item), findItemInWebCache(String), findItemInAnything(Object, String), getItemFromCatalog(String), getItemFromWebCache(Collection, String), getItemFromWebCache(String), getItemFromWebCache(Room, String), getItemFromWebCache(MOB, String), findItemWebCacheCode(MOB, Item), findItemWebCacheCode(Collection, Item), findItemWebCacheCode(Item), findItemWebCacheCode(Room, Item), isWebCachedItem(Object)

contributeMOBsToWebCache

java.util.Collection<MOB> contributeMOBsToWebCache(java.util.Collection<MOB> inhabs)

Adds the given mobs to the web cache, if each one qualifies to be so added.

Parameters:

inhabs - the mobs to add to the web cache

Returns:

the mob web cache

See Also:

findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

findMOBMatchInWebCache

MOB findMOBMatchInWebCache(MOB M)

Searches the official web cache for a mob like the given one, and returns it if found.

Parameters:

M - the mob to find a match for

Returns:

null, or the found cached mob

See Also:

contributeMOBsToWebCache(Collection), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

getMOBFromAnywhere

MOB getMOBFromAnywhere(java.lang.String MATCHING)

Given some sort of mob-finding code, including catalog codes, mob class ids, catalog codes, web cache codes, and general canonical java class names, this will return the best mob match it can find.

Parameters:

MATCHING - the mob finding code

Returns:

the mob found, or null

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

getMOBFromCatalog

MOB getMOBFromCatalog(java.lang.String MATCHING)

If the given mob cache code is a catalog code, this will return the mob from the catalog, if found.

Parameters:

MATCHING - the catalog cache code

Returns:

null, or the found mob

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

getMOBFromWebCache

MOB getMOBFromWebCache(java.util.Collection<MOB> allmobs,
                       java.lang.String code)

Searches the given mob web cache for the mob of the given code, which might be a catalog code also. If found, the mob is returned.

Parameters:

allmobs - your mob web cache

code - the mob cache code

Returns:

null, or the found mob

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

getMOBFromWebCache

MOB getMOBFromWebCache(java.lang.String code)

Searches the official mob web cache for the mob of the given code, which might be a catalog code also. If found, the mob is returned.

Parameters:

code - the mob code to get a mob for

Returns:

null, or the found mob

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

getMOBFromWebCache

MOB getMOBFromWebCache(Room R,
                       java.lang.String code)

Finds the mob in the given room with the given web cache code and returns the mob object from the cache. If the Room is null, the normal cache is searched.

Parameters:

R - the room the mob with the code must be in

code - the mob cache code

Returns:

null, or the mob matching the code

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

findMOBWebCacheCode

java.lang.String findMOBWebCacheCode(java.util.Collection<MOB> mobs,
                                     MOB M)

Given your own mob cache, this will find the mob just like the given one and return its code.

Parameters:

mobs - the mob cache

M - the mob to look for

Returns:

the mobs cache code, or ""

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

findMOBWebCacheCode

java.lang.String findMOBWebCacheCode(MOB M)

Searches for a mob in the web cache that is just like the given mob, and returns the cache code.

Parameters:

M - the mob to search for

Returns:

the mobs cache code, or ""

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

findMOBWebCacheCode

java.lang.String findMOBWebCacheCode(Room R,
                                     MOB M)

Returns the room-context cache code for the given mob, if it is really in the room. This does a pure object comparison, so mob copies wouldn't work.

Parameters:

R - the room to look in

M - the mob to get a code for

Returns:

the mob web cache code or ""

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), isWebCachedMOB(Object), getMOBWebCacheIterable()

isWebCachedMOB

boolean isWebCachedMOB(java.lang.Object M)

Returns whether the given mob is in the web cache.

Parameters:

M - the mob to look for

Returns:

true if its in the cache, false otherwise

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), getMOBWebCacheIterable()

getMOBWebCacheIterable

java.lang.Iterable<MOB> getMOBWebCacheIterable()

Returns an iterator through the mob web cache.

Returns:

an iterator through the mob web cache.

See Also:

contributeMOBsToWebCache(Collection), findMOBMatchInWebCache(MOB), getMOBFromAnywhere(String), getMOBFromCatalog(String), getMOBFromWebCache(Collection, String), getMOBFromWebCache(String), getMOBFromWebCache(Room, String), findMOBWebCacheCode(Collection, MOB), findMOBWebCacheCode(MOB), findMOBWebCacheCode(Room, MOB), isWebCachedMOB(Object)