Package com.planet_ink.coffee_mud.Libraries

Class WebMacroCreamer

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.WebMacroCreamer

All Implemented Interfaces:

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

public class WebMacroCreamer
extends StdLibrary
implements WebMacroLibrary, com.planet_ink.coffee_web.interfaces.SimpleServlet

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WebMacroCreamer.JScriptablePage

Field Summary

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

idConverter

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

isDebugging, name, serviceClient, tickStatus

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_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, 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_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Constructor Summary

Constructors

Constructor	Description
WebMacroCreamer()

Method Summary

Modifier and Type	Method	Description
boolean	activate()	Activates the library.
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.
java.nio.ByteBuffer	convertOutput(com.planet_ink.coffee_web.util.CWConfig config, com.planet_ink.coffee_web.interfaces.HTTPRequest request, java.io.File pageFile, com.planet_ink.coffee_web.http.HTTPStatus status, java.nio.ByteBuffer buffer)	Standard method for converting an intput buffer for writing to the client.
void	doGet(com.planet_ink.coffee_web.interfaces.SimpleServletRequest request, com.planet_ink.coffee_web.interfaces.SimpleServletResponse response)
void	doPost(com.planet_ink.coffee_web.interfaces.SimpleServletRequest request, com.planet_ink.coffee_web.interfaces.SimpleServletResponse response)
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 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.
TickClient	getServiceClient()	If this library has a service thread, this method returns the TickClient object associated with that service.
int	getTickStatus()	A coded status for this object during the period where its tick method is being called.
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.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
void	init()
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.
protected int	myBack(java.lang.StringBuffer s, int i, java.lang.String[] lastFoundMacro)
protected int	myElse(java.lang.StringBuffer s, int i, int end, java.lang.String[] lastFoundMacro)
protected int	myEndif(java.lang.StringBuffer s, int i, java.lang.String[] lastFoundMacro)
protected int	myNext(java.lang.StringBuffer s, int i, java.lang.String[] lastFoundMacro)
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.
protected java.lang.String	parseFoundMacro(java.lang.StringBuffer s, int i, java.lang.String[] lastFoundMacro, boolean lookOnly)
protected java.lang.String	runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest request, java.lang.String foundMacro, java.lang.String[] lastFoundMacro, boolean isAdminServer)
void	service(com.planet_ink.coffee_web.http.HTTPMethod method, com.planet_ink.coffee_web.interfaces.SimpleServletRequest request, com.planet_ink.coffee_web.interfaces.SimpleServletResponse response)
boolean	shutdown()	Shuts down the library.
boolean	tick(Tickable ticking, int tickID)	this is the method which is called periodically by the threading engine.
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 s)	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

L, propertiesLoaded

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

copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

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

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

checkDatabase, compareTo, copyOf, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus

Constructor Detail

WebMacroCreamer

public WebMacroCreamer()

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

convertOutput

public java.nio.ByteBuffer convertOutput(com.planet_ink.coffee_web.util.CWConfig config,
                                         com.planet_ink.coffee_web.interfaces.HTTPRequest request,
                                         java.io.File pageFile,
                                         com.planet_ink.coffee_web.http.HTTPStatus status,
                                         java.nio.ByteBuffer buffer)
                                  throws com.planet_ink.coffee_web.http.HTTPException

Description copied from interface: com.planet_ink.coffee_web.interfaces.HTTPOutputConverter

Standard method for converting an intput buffer for writing to the client. The position and limit of the bytebuffer must already be set for reading the content. Call generateOutput() to get the new output.

Specified by:

convertOutput in interface com.planet_ink.coffee_web.interfaces.HTTPOutputConverter

Parameters:

config - the http configuration

request - the http request bring processed

pageFile - the file whose data is being converted

status - the status of the request (so far)

buffer - the input buffer

Returns:

the output buffer

Throws:

com.planet_ink.coffee_web.http.HTTPException - a generated http error to pass to the user

virtualPageFilter

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

Description copied from interface: WebMacroLibrary

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

Specified by:

virtualPageFilter in interface WebMacroLibrary

Parameters:

data - the fake page to filter

Returns:

the filtered page data

Throws:

HTTPRedirectException - any redirect exceptions encountered

See Also:

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

virtualPageFilter

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

Description copied from interface: WebMacroLibrary

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

Specified by:

virtualPageFilter in interface WebMacroLibrary

Parameters:

data - the fake page to filter

Returns:

the filtered page data

Throws:

HTTPRedirectException - any redirect exceptions encountered

See Also:

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

virtualPageFilter

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

Description copied from interface: WebMacroLibrary

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

Specified by:

virtualPageFilter in interface WebMacroLibrary

Parameters:

data - the fake page to filter

Returns:

the filtered page data

Throws:

HTTPRedirectException - any redirect exceptions encountered

See Also:

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

virtualPageFilter

public 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

Description copied from interface: WebMacroLibrary

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

Specified by:

virtualPageFilter in interface WebMacroLibrary

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:

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

clearWebMacros

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

Description copied from interface: WebMacroLibrary

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

Specified by:

clearWebMacros in interface WebMacroLibrary

Parameters:

s - the string to clear or web

Returns:

the modified and cleared string

parseFoundMacro

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

Description copied from interface: WebMacroLibrary

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.

Specified by:

parseFoundMacro in interface WebMacroLibrary

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

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

Description copied from interface: WebMacroLibrary

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

Specified by:

clearWebMacros in interface WebMacroLibrary

Parameters:

s - the string to clear or web

Returns:

the modified and cleared string

virtualPageFilter

public 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 s)
                                         throws HTTPRedirectException

Description copied from interface: WebMacroLibrary

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

Specified by:

virtualPageFilter in interface WebMacroLibrary

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

s - 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:

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

runMacro

protected java.lang.String runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest request,
                                    java.lang.String foundMacro,
                                    java.lang.String[] lastFoundMacro,
                                    boolean isAdminServer)
                             throws HTTPRedirectException,
                                    HTTPServerException

Throws:

HTTPRedirectException

HTTPServerException

parseFoundMacro

protected java.lang.String parseFoundMacro(java.lang.StringBuffer s,
                                           int i,
                                           java.lang.String[] lastFoundMacro,
                                           boolean lookOnly)

myElse

protected int myElse(java.lang.StringBuffer s,
                     int i,
                     int end,
                     java.lang.String[] lastFoundMacro)

myBack

protected int myBack(java.lang.StringBuffer s,
                     int i,
                     java.lang.String[] lastFoundMacro)

myNext

protected int myNext(java.lang.StringBuffer s,
                     int i,
                     java.lang.String[] lastFoundMacro)

myEndif

protected int myEndif(java.lang.StringBuffer s,
                      int i,
                      java.lang.String[] lastFoundMacro)

init

public void init()

Specified by:

init in interface com.planet_ink.coffee_web.interfaces.SimpleServlet

doGet

public void doGet(com.planet_ink.coffee_web.interfaces.SimpleServletRequest request,
                  com.planet_ink.coffee_web.interfaces.SimpleServletResponse response)
           throws com.planet_ink.coffee_web.http.HTTPException

Specified by:

doGet in interface com.planet_ink.coffee_web.interfaces.SimpleServlet

Throws:

com.planet_ink.coffee_web.http.HTTPException

doPost

public void doPost(com.planet_ink.coffee_web.interfaces.SimpleServletRequest request,
                   com.planet_ink.coffee_web.interfaces.SimpleServletResponse response)
            throws com.planet_ink.coffee_web.http.HTTPException

Specified by:

doPost in interface com.planet_ink.coffee_web.interfaces.SimpleServlet

Throws:

com.planet_ink.coffee_web.http.HTTPException

service

public void service(com.planet_ink.coffee_web.http.HTTPMethod method,
                    com.planet_ink.coffee_web.interfaces.SimpleServletRequest request,
                    com.planet_ink.coffee_web.interfaces.SimpleServletResponse response)
             throws com.planet_ink.coffee_web.http.HTTPException

Specified by:

service in interface com.planet_ink.coffee_web.interfaces.SimpleServlet

Throws:

com.planet_ink.coffee_web.http.HTTPException

activate

public boolean activate()

Description copied from interface: CMLibrary

Activates the library. This is called after the mud is booted, but before connections are accepted.

Specified by:

activate in interface CMLibrary

Overrides:

activate in class StdLibrary

Returns:

true if activation was successful, false if you're screwed

See Also:

CMLibrary.shutdown()

shutdown

public boolean shutdown()

Description copied from interface: CMLibrary

Shuts down the library. Called at system shutdown time obviously, but is sometimes called just to reset the library.

Specified by:

shutdown in interface CMLibrary

Overrides:

shutdown in class StdLibrary

Returns:

true if shutdown was successful, false if there's nothing you can do about it

See Also:

CMLibrary.activate()

getServiceClient

public TickClient getServiceClient()

Description copied from interface: CMLibrary

If this library has a service thread, this method returns the TickClient object associated with that service. Normally returns null, since most libraries don't set themselves up to receive thread time.

Specified by:

getServiceClient in interface CMLibrary

Overrides:

getServiceClient in class StdLibrary

Returns:

null, or the TickClient for the service

See Also:

TickClient

getTickStatus

public int getTickStatus()

Description copied from interface: Tickable

A coded status for this object during the period where its tick method is being called. The statis is defined, at least in part, by constants in this interface STATUS_*. STATUS_NOT should be returned when the objects tick method is not currently in execution. It should never return STATUS_NOT when the objects tick method is in execution.

Specified by:

getTickStatus in interface Tickable

Overrides:

getTickStatus in class StdLibrary

Returns:

the numeric status of this object

See Also:

Tickable.tick(Tickable, int)

tick

public boolean tick(Tickable ticking,
                    int tickID)

Description copied from interface: Tickable

this is the method which is called periodically by the threading engine. How often it is called depends on the parameters passed to the threadding engine when it is submitted for thread access. Typically the period is once per TIME_TICK period, but that is determined when the object is submitted to the thread engine.

Specified by:

tick in interface Tickable

Overrides:

tick in class StdLibrary

Parameters:

ticking - a reference to this Tickable object

tickID - the TICKID_ constant describing this periodic call, as defined in Tickable

Returns:

true always, unless this object no longer wishes to ever tick again, in which case false

See Also:

Tickable, ServiceEngine, TickableGroup

getMOBWebCacheIterable

public java.lang.Iterable<MOB> getMOBWebCacheIterable()

Description copied from interface: WebMacroLibrary

Returns an iterator through the mob web cache.

Specified by:

getMOBWebCacheIterable in interface WebMacroLibrary

Returns:

an iterator through the mob web cache.

See Also:

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

isWebCachedMOB

public boolean isWebCachedMOB(java.lang.Object M)

Description copied from interface: WebMacroLibrary

Returns whether the given mob is in the web cache.

Specified by:

isWebCachedMOB in interface WebMacroLibrary

Parameters:

M - the mob to look for

Returns:

true if its in the cache, false otherwise

See Also:

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

getItemWebCacheIterable

public java.lang.Iterable<Item> getItemWebCacheIterable()

Description copied from interface: WebMacroLibrary

Returns an iterable of the item web cache.

Specified by:

getItemWebCacheIterable in interface WebMacroLibrary

Returns:

an iterable of the item web cache.

See Also:

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

isWebCachedItem

public boolean isWebCachedItem(java.lang.Object I)

Description copied from interface: WebMacroLibrary

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

Specified by:

isWebCachedItem in interface WebMacroLibrary

Parameters:

I - the item to look for

Returns:

true if that item object is in the cache

See Also:

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

findItemWebCacheCode

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

Description copied from interface: WebMacroLibrary

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

Specified by:

findItemWebCacheCode in interface WebMacroLibrary

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:

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

findItemWebCacheCode

public java.lang.String findItemWebCacheCode(Item I)

Description copied from interface: WebMacroLibrary

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

Specified by:

findItemWebCacheCode in interface WebMacroLibrary

Parameters:

I - the item to find like

Returns:

"", or the item web cache code

See Also:

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

findItemWebCacheCode

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

Description copied from interface: WebMacroLibrary

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

Specified by:

findItemWebCacheCode in interface WebMacroLibrary

Parameters:

allitems - the web item cache to use

I - the item to find like

Returns:

"", or the item web cache code

See Also:

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

findItemWebCacheCode

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

Description copied from interface: WebMacroLibrary

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

Specified by:

findItemWebCacheCode in interface WebMacroLibrary

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:

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

findMOBWebCacheCode

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

Description copied from interface: WebMacroLibrary

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.

Specified by:

findMOBWebCacheCode in interface WebMacroLibrary

Parameters:

R - the room to look in

M - the mob to get a code for

Returns:

the mob web cache code or ""

See Also:

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

findMOBWebCacheCode

public java.lang.String findMOBWebCacheCode(MOB M)

Description copied from interface: WebMacroLibrary

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

Specified by:

findMOBWebCacheCode in interface WebMacroLibrary

Parameters:

M - the mob to search for

Returns:

the mobs cache code, or ""

See Also:

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

findMOBWebCacheCode

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

Description copied from interface: WebMacroLibrary

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

Specified by:

findMOBWebCacheCode in interface WebMacroLibrary

Parameters:

mobs - the mob cache

M - the mob to look for

Returns:

the mobs cache code, or ""

See Also:

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

getItemFromWebCache

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

Description copied from interface: WebMacroLibrary

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.

Specified by:

getItemFromWebCache in interface WebMacroLibrary

Parameters:

M - the mob item owner

code - the item code

Returns:

null, or the item

See Also:

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

getItemFromWebCache

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

Description copied from interface: WebMacroLibrary

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

Specified by:

getItemFromWebCache in interface WebMacroLibrary

Parameters:

R - the room item owner

code - the item code

Returns:

null, or the item

See Also:

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

getItemFromWebCache

public Item getItemFromWebCache(java.lang.String code)

Description copied from interface: WebMacroLibrary

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

Specified by:

getItemFromWebCache in interface WebMacroLibrary

Parameters:

code - the item web cache code, or catalog code

Returns:

null, or the item

See Also:

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

getItemFromWebCache

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

Description copied from interface: WebMacroLibrary

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

Specified by:

getItemFromWebCache in interface WebMacroLibrary

Parameters:

allitems - the item web cache to use

code - the item web cache code, or catalog code

Returns:

null, or the item

See Also:

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

getMOBFromWebCache

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

Description copied from interface: WebMacroLibrary

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.

Specified by:

getMOBFromWebCache in interface WebMacroLibrary

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:

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

getMOBFromWebCache

public MOB getMOBFromWebCache(java.lang.String code)

Description copied from interface: WebMacroLibrary

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.

Specified by:

getMOBFromWebCache in interface WebMacroLibrary

Parameters:

code - the mob code to get a mob for

Returns:

null, or the found mob

See Also:

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

getMOBFromWebCache

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

Description copied from interface: WebMacroLibrary

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.

Specified by:

getMOBFromWebCache in interface WebMacroLibrary

Parameters:

allmobs - your mob web cache

code - the mob cache code

Returns:

null, or the found mob

See Also:

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

getMOBFromCatalog

public MOB getMOBFromCatalog(java.lang.String MATCHING)

Description copied from interface: WebMacroLibrary

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

Specified by:

getMOBFromCatalog in interface WebMacroLibrary

Parameters:

MATCHING - the catalog cache code

Returns:

null, or the found mob

See Also:

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

getItemFromCatalog

public Item getItemFromCatalog(java.lang.String MATCHING)

Description copied from interface: WebMacroLibrary

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

Specified by:

getItemFromCatalog in interface WebMacroLibrary

Parameters:

MATCHING - the catalog item code

Returns:

null, or the item

See Also:

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

getAppropriateCode

public java.lang.String getAppropriateCode(PhysicalAgent E,
                                           Physical RorM,
                                           java.util.Collection classes)

Description copied from interface: WebMacroLibrary

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.

Specified by:

getAppropriateCode in interface WebMacroLibrary

Parameters:

E - the object to get a code for

RorM - an item owner

classes - a web cache

Returns:

the appropriate code for the object

findItemInWebCache

public Item findItemInWebCache(java.lang.String MATCHING)

Description copied from interface: WebMacroLibrary

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.

Specified by:

findItemInWebCache in interface WebMacroLibrary

Parameters:

MATCHING - the item code to look for

Returns:

the item, if found

See Also:

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

findItemInAnything

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

Description copied from interface: WebMacroLibrary

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.

Specified by:

findItemInAnything in interface WebMacroLibrary

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:

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

getMOBFromAnywhere

public MOB getMOBFromAnywhere(java.lang.String MATCHING)

Description copied from interface: WebMacroLibrary

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.

Specified by:

getMOBFromAnywhere in interface WebMacroLibrary

Parameters:

MATCHING - the mob finding code

Returns:

the mob found, or null

See Also:

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

findMOBMatchInWebCache

public MOB findMOBMatchInWebCache(MOB M)

Description copied from interface: WebMacroLibrary

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

Specified by:

findMOBMatchInWebCache in interface WebMacroLibrary

Parameters:

M - the mob to find a match for

Returns:

null, or the found cached mob

See Also:

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

findItemMatchInWebCache

public Item findItemMatchInWebCache(Item I)

Description copied from interface: WebMacroLibrary

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

Specified by:

findItemMatchInWebCache in interface WebMacroLibrary

Parameters:

I - the item to look for like

Returns:

the item from the cache, or null

See Also:

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

contributeMOBsToWebCache

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

Description copied from interface: WebMacroLibrary

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

Specified by:

contributeMOBsToWebCache in interface WebMacroLibrary

Parameters:

inhabs - the mobs to add to the web cache

Returns:

the mob web cache

See Also:

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

isAllNum

public boolean isAllNum(java.lang.String str)

Description copied from interface: WebMacroLibrary

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

Specified by:

isAllNum in interface WebMacroLibrary

Parameters:

str - the string to check

Returns:

true if it resembles a web cache code

contributeItemsToWebCache

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

Description copied from interface: WebMacroLibrary

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

Specified by:

contributeItemsToWebCache in interface WebMacroLibrary

Parameters:

items - the collection of items to submit

Returns:

the item web cache again

See Also:

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

getWebCacheSuffix

public java.lang.String getWebCacheSuffix(Environmental E)

Description copied from interface: WebMacroLibrary

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.

Specified by:

getWebCacheSuffix in interface WebMacroLibrary

Parameters:

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

Returns:

an expiration description