com.planet_ink.coffee_mud.WebMacros
Class FileMgr

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

All Implemented Interfaces:

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

public class FileMgr
extends StdWebMacro

Constructor Summary

FileMgr()

Method Summary

void	compileFilenamesList(CMFile F, java.lang.String regex, java.util.Vector V)
void	compileTextListFromFiles(java.util.Vector files, java.lang.String regex, java.util.Vector V)
boolean	isAdminMacro() Whether this macro is restricted to the admin web server.
boolean	matches(java.lang.String s1, java.lang.String s2)
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, 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

FileMgr

public FileMgr()

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

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

matches

public boolean matches(java.lang.String s1,
                       java.lang.String s2)

compileFilenamesList

public void compileFilenamesList(CMFile F,
                                 java.lang.String regex,
                                 java.util.Vector V)

compileTextListFromFiles

public void compileTextListFromFiles(java.util.Vector files,
                                     java.lang.String regex,
                                     java.util.Vector V)

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