Class AreaNameEncoded

  extended by com.planet_ink.coffee_mud.WebMacros.StdWebMacro
      extended by com.planet_ink.coffee_mud.WebMacros.AreaNameEncoded
All Implemented Interfaces:
CMObject, WebMacro, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class AreaNameEncoded
extends StdWebMacro

Constructor Summary
Method Summary
 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 com.planet_ink.coffee_mud.WebMacros.StdWebMacro
clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getHTTPFileData, grabFile, helpHelp, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAdminMacro, isAWebPath, L, newInstance, parseOrderedParms, parseParms, parseParms, preferBinary, runBinaryMacro, safeIncomingfilter, webify
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public AreaNameEncoded()
Method Detail


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
name in class StdWebMacro
The public name of this macro
See Also:


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
runMacro in class StdWebMacro
httpReq - the external requests object
parm - any parameter strings given to the macro
httpResp - the response, with headers
the string result of running this macro
See Also:
WebMacro.preferBinary(), HTTPRequest