com.planet_ink.coffee_mud.WebMacros
Class RebuildReferenceDocs

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

All Implemented Interfaces:

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

public class RebuildReferenceDocs
extends StdWebMacro

Constructor Summary

RebuildReferenceDocs()

Method Summary

boolean	isAdminMacro() Whether this macro is restricted to the admin web server.
boolean	isAWebPath() Whether this macro substitutes as an aspect of the web path instead of a standard web macro.
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, 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

RebuildReferenceDocs

public RebuildReferenceDocs()

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

isAWebPath

public boolean isAWebPath()

Description copied from interface: WebMacro

Whether this macro substitutes as an aspect of the web path instead of a standard web macro. If true is returned, URLs such as: http://mydomain.com/mymacroname?firstparm=value&secondparm=value might succeeed

Specified by:

isAWebPath in interface WebMacro

Overrides:

isAWebPath in class StdWebMacro

Returns:

whether this is a wierd URL macro

See Also:

WebMacro.getFilename(ExternalHTTPRequests, String)

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

runMacro

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

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

Throws:

HTTPServerException

See Also:

WebMacro.preferBinary(), ExternalHTTPRequests