com.planet_ink.coffee_mud.WebMacros
Class AreaData

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

All Implemented Interfaces:

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

public class AreaData
extends StdWebMacro

Constructor Summary

AreaData()

Method Summary

static java.lang.StringBuffer	affects(Physical P, ExternalHTTPRequests httpReq, java.util.Map<java.lang.String,java.lang.String> parms, int borderSize)
static java.lang.StringBuffer	behaves(PhysicalAgent E, ExternalHTTPRequests httpReq, java.util.Map<java.lang.String,java.lang.String> parms, int borderSize)
java.lang.String	name() The public name of this macro
java.lang.String	runMacro(ExternalHTTPRequests httpReq, java.lang.String parm) This method is executed only if this macro returns false for preferBinary().

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

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getFilename, getSpecialContentHeader, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAdminMacro, isAWebPath, newInstance, parseOrderedParms, parseParms, preferBinary, runBinaryMacro, webify

Methods inherited from class java.lang.Object

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

Constructor Detail

AreaData

public AreaData()

Method Detail

name

public java.lang.String name()

Description copied from interface: WebMacro

The public name of this macro

Specified by:

name in interface WebMacro

Overrides:

name in class StdWebMacro

Returns:

The public name of this macro

behaves

public static java.lang.StringBuffer behaves(PhysicalAgent E,
                                             ExternalHTTPRequests httpReq,
                                             java.util.Map<java.lang.String,java.lang.String> parms,
                                             int borderSize)

affects

public static java.lang.StringBuffer affects(Physical P,
                                             ExternalHTTPRequests httpReq,
                                             java.util.Map<java.lang.String,java.lang.String> parms,
                                             int borderSize)

runMacro

public java.lang.String runMacro(ExternalHTTPRequests httpReq,
                                 java.lang.String parm)

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.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strigs given to the macro

Returns:

the string result of running this macro

See Also:

WebMacro.preferBinary(), ExternalHTTPRequests