Package com.planet_ink.coffee_mud.WebMacros

Class AreaScriptNext

java.lang.Object

com.planet_ink.coffee_mud.WebMacros.StdWebMacro

com.planet_ink.coffee_mud.WebMacros.AreaScriptNext

All Implemented Interfaces:

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

Direct Known Subclasses:

AreaScriptData

public class AreaScriptNext
extends StdWebMacro

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AreaScriptNext.AreaScriptInstance

Field Summary

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

idConverter

Constructor Summary

Constructors

Constructor	Description
AreaScriptNext()

Method Summary

Modifier and Type	Method	Description
AreaScriptNext.AreaScriptInstance	addScript(java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>> list, java.util.ArrayList<java.lang.String> prefix, java.lang.String scriptKey, java.lang.String immediateHost, java.lang.String key, java.lang.String file)
void	addScripts(java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>> list, java.util.ArrayList<java.lang.String> prefix, PhysicalAgent E)
void	addShopScripts(java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>> list, java.util.ArrayList<java.lang.String> prefix, PhysicalAgent E)
java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>>	getAreaScripts(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String area)
boolean	isAdminMacro()	Whether this macro is restricted to the admin web server.
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().

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.WebMacros.StdWebMacro

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

Constructor Detail

AreaScriptNext

public AreaScriptNext()

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()

isAdminMacro

public boolean isAdminMacro()

Description copied from interface: WebMacro

Whether this macro is restricted to the admin web server.

Specified by:

isAdminMacro in interface WebMacro

Overrides:

isAdminMacro in class StdWebMacro

Returns:

true if the macro is restricted to the admin web server

addScript

public AreaScriptNext.AreaScriptInstance addScript(java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>> list,
                                                   java.util.ArrayList<java.lang.String> prefix,
                                                   java.lang.String scriptKey,
                                                   java.lang.String immediateHost,
                                                   java.lang.String key,
                                                   java.lang.String file)

addScripts

public void addScripts(java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>> list,
                       java.util.ArrayList<java.lang.String> prefix,
                       PhysicalAgent E)

addShopScripts

public void addShopScripts(java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>> list,
                           java.util.ArrayList<java.lang.String> prefix,
                           PhysicalAgent E)

getAreaScripts

public java.util.TreeMap<java.lang.String,java.util.ArrayList<AreaScriptNext.AreaScriptInstance>> getAreaScripts(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                                                                                                 java.lang.String area)

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