| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Wed Apr 14 08:26:32 EDT 2004 --> |
| <TITLE> |
| Velocity 1.4 API: Class VelocimacroFactory |
| </TITLE> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <BODY BGCOLOR="white"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VelocimacroFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/velocity/runtime/RuntimeSingleton.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.Twonk.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="VelocimacroFactory.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#inner_class_summary">INNER</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.velocity.runtime</FONT> |
| <BR> |
| Class VelocimacroFactory</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--<B>org.apache.velocity.runtime.VelocimacroFactory</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public class <B>VelocimacroFactory</B><DT>extends java.lang.Object</DL> |
| |
| <P> |
| VelocimacroFactory.java |
| |
| manages the set of VMs in a running Velocity engine. |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Id: VelocimacroFactory.java,v 1.17.4.1 2004/03/03 23:22:55 geirm Exp $</DD> |
| <DT><B>Author: </B><DD><a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| <A NAME="inner_class_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Inner Class Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.Twonk.html">VelocimacroFactory.Twonk</A></B></CODE> |
| |
| <BR> |
| small continer class to hold the duple |
| of a template and modification time.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#addNewAllowed">addNewAllowed</A></B></CODE> |
| |
| <BR> |
| controls if new VMs can be added.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#autoReloadLibrary">autoReloadLibrary</A></B></CODE> |
| |
| <BR> |
| determines if the libraries are auto-loaded |
| when they change</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#blather">blather</A></B></CODE> |
| |
| <BR> |
| controls log output</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#libModMap">libModMap</A></B></CODE> |
| |
| <BR> |
| map of the library Template objects |
| used for reload determination</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.util.Vector</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#macroLibVec">macroLibVec</A></B></CODE> |
| |
| <BR> |
| vector of the library names</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#replaceAllowed">replaceAllowed</A></B></CODE> |
| |
| <BR> |
| determines if replacement of global VMs are allowed |
| controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private <A HREF="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#rsvc">rsvc</A></B></CODE> |
| |
| <BR> |
| runtime services for this instance</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#templateLocal">templateLocal</A></B></CODE> |
| |
| <BR> |
| sets if template-local namespace in used</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private <A HREF="../../../../org/apache/velocity/runtime/VelocimacroManager.html">VelocimacroManager</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#vmManager">vmManager</A></B></CODE> |
| |
| <BR> |
| VMManager : deal with namespace management |
| and actually keeps all the VM definitions</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#VelocimacroFactory(org.apache.velocity.runtime.RuntimeServices)">VelocimacroFactory</A></B>(<A HREF="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</A> rs)</CODE> |
| |
| <BR> |
| CTOR : requires a runtime services from now |
| on</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#addVelocimacro(java.lang.String, java.lang.String, java.lang.String[], java.lang.String)">addVelocimacro</A></B>(java.lang.String name, |
| java.lang.String macroBody, |
| java.lang.String[] argArray, |
| java.lang.String sourceTemplate)</CODE> |
| |
| <BR> |
| adds a macro to the factory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#canAddVelocimacro(java.lang.String, java.lang.String)">canAddVelocimacro</A></B>(java.lang.String name, |
| java.lang.String sourceTemplate)</CODE> |
| |
| <BR> |
| determines if a given macro/namespace (name, source) combo is allowed |
| to be added</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#dumpVMNamespace(java.lang.String)">dumpVMNamespace</A></B>(java.lang.String namespace)</CODE> |
| |
| <BR> |
| tells the vmManager to dump the specified namespace</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#getAutoload()">getAutoload</A></B>()</CODE> |
| |
| <BR> |
| get the switch for automatic reloading of |
| global library-based VMs</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#getBlather()">getBlather</A></B>()</CODE> |
| |
| <BR> |
| get output message mode</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#getTemplateLocalInline()">getTemplateLocalInline</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#getVelocimacro(java.lang.String, java.lang.String)">getVelocimacro</A></B>(java.lang.String vmName, |
| java.lang.String sourceTemplate)</CODE> |
| |
| <BR> |
| actual factory : creates a Directive that will |
| behave correctly wrt getting the framework to |
| dig out the correct # of args</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#initVelocimacro()">initVelocimacro</A></B>()</CODE> |
| |
| <BR> |
| initialize the factory - setup all permissions |
| load all global libraries.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#isVelocimacro(java.lang.String, java.lang.String)">isVelocimacro</A></B>(java.lang.String vm, |
| java.lang.String sourceTemplate)</CODE> |
| |
| <BR> |
| Tells the world if a given directive string is a Velocimacro</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#logVMMessageInfo(java.lang.String)">logVMMessageInfo</A></B>(java.lang.String s)</CODE> |
| |
| <BR> |
| localization of the logging logic</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#logVMMessageWarn(java.lang.String)">logVMMessageWarn</A></B>(java.lang.String s)</CODE> |
| |
| <BR> |
| localization of the logging logic</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#setAddMacroPermission(boolean)">setAddMacroPermission</A></B>(boolean arg)</CODE> |
| |
| <BR> |
| sets the permission to add new macros</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#setAutoload(boolean)">setAutoload</A></B>(boolean b)</CODE> |
| |
| <BR> |
| set the switch for automatic reloading of |
| global library-based VMs</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#setBlather(boolean)">setBlather</A></B>(boolean b)</CODE> |
| |
| <BR> |
| set output message mode</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#setReplacementPermission(boolean)">setReplacementPermission</A></B>(boolean arg)</CODE> |
| |
| <BR> |
| sets the permission for allowing addMacro() calls to |
| replace existing VM's</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.html#setTemplateLocalInline(boolean)">setTemplateLocalInline</A></B>(boolean b)</CODE> |
| |
| <BR> |
| sets permission to have VMs local in scope to their declaring template |
| note that this is really taken care of in the VMManager class, but |
| we need it here for gating purposes in addVM |
| eventually, I will slide this all into the manager, maybe.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><clinit>, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="rsvc"><!-- --></A><H3> |
| rsvc</H3> |
| <PRE> |
| private <A HREF="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</A> <B>rsvc</B></PRE> |
| <DL> |
| <DD>runtime services for this instance</DL> |
| <HR> |
| |
| <A NAME="vmManager"><!-- --></A><H3> |
| vmManager</H3> |
| <PRE> |
| private <A HREF="../../../../org/apache/velocity/runtime/VelocimacroManager.html">VelocimacroManager</A> <B>vmManager</B></PRE> |
| <DL> |
| <DD>VMManager : deal with namespace management |
| and actually keeps all the VM definitions</DL> |
| <HR> |
| |
| <A NAME="replaceAllowed"><!-- --></A><H3> |
| replaceAllowed</H3> |
| <PRE> |
| private boolean <B>replaceAllowed</B></PRE> |
| <DL> |
| <DD>determines if replacement of global VMs are allowed |
| controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL</DL> |
| <HR> |
| |
| <A NAME="addNewAllowed"><!-- --></A><H3> |
| addNewAllowed</H3> |
| <PRE> |
| private boolean <B>addNewAllowed</B></PRE> |
| <DL> |
| <DD>controls if new VMs can be added. Set by |
| VM_PERM_ALLOW_INLINE Note the assumption that only |
| through inline defs can this happen. |
| additions through autoloaded VMs is allowed</DL> |
| <HR> |
| |
| <A NAME="templateLocal"><!-- --></A><H3> |
| templateLocal</H3> |
| <PRE> |
| private boolean <B>templateLocal</B></PRE> |
| <DL> |
| <DD>sets if template-local namespace in used</DL> |
| <HR> |
| |
| <A NAME="blather"><!-- --></A><H3> |
| blather</H3> |
| <PRE> |
| private boolean <B>blather</B></PRE> |
| <DL> |
| <DD>controls log output</DL> |
| <HR> |
| |
| <A NAME="autoReloadLibrary"><!-- --></A><H3> |
| autoReloadLibrary</H3> |
| <PRE> |
| private boolean <B>autoReloadLibrary</B></PRE> |
| <DL> |
| <DD>determines if the libraries are auto-loaded |
| when they change</DL> |
| <HR> |
| |
| <A NAME="macroLibVec"><!-- --></A><H3> |
| macroLibVec</H3> |
| <PRE> |
| private java.util.Vector <B>macroLibVec</B></PRE> |
| <DL> |
| <DD>vector of the library names</DL> |
| <HR> |
| |
| <A NAME="libModMap"><!-- --></A><H3> |
| libModMap</H3> |
| <PRE> |
| private java.util.Map <B>libModMap</B></PRE> |
| <DL> |
| <DD>map of the library Template objects |
| used for reload determination</DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="VelocimacroFactory(org.apache.velocity.runtime.RuntimeServices)"><!-- --></A><H3> |
| VelocimacroFactory</H3> |
| <PRE> |
| public <B>VelocimacroFactory</B>(<A HREF="../../../../org/apache/velocity/runtime/RuntimeServices.html">RuntimeServices</A> rs)</PRE> |
| <DL> |
| <DD>CTOR : requires a runtime services from now |
| on</DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="initVelocimacro()"><!-- --></A><H3> |
| initVelocimacro</H3> |
| <PRE> |
| public void <B>initVelocimacro</B>()</PRE> |
| <DL> |
| <DD>initialize the factory - setup all permissions |
| load all global libraries.</DL> |
| <HR> |
| |
| <A NAME="addVelocimacro(java.lang.String, java.lang.String, java.lang.String[], java.lang.String)"><!-- --></A><H3> |
| addVelocimacro</H3> |
| <PRE> |
| public boolean <B>addVelocimacro</B>(java.lang.String name, |
| java.lang.String macroBody, |
| java.lang.String[] argArray, |
| java.lang.String sourceTemplate)</PRE> |
| <DL> |
| <DD>adds a macro to the factory.</DL> |
| <HR> |
| |
| <A NAME="canAddVelocimacro(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| canAddVelocimacro</H3> |
| <PRE> |
| private boolean <B>canAddVelocimacro</B>(java.lang.String name, |
| java.lang.String sourceTemplate)</PRE> |
| <DL> |
| <DD>determines if a given macro/namespace (name, source) combo is allowed |
| to be added<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of VM to add<DD><CODE>sourceTemplate</CODE> - Source template that contains the defintion of the VM<DT><B>Returns:</B><DD>true if it is allowed to be added, false otherwise</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="logVMMessageInfo(java.lang.String)"><!-- --></A><H3> |
| logVMMessageInfo</H3> |
| <PRE> |
| private void <B>logVMMessageInfo</B>(java.lang.String s)</PRE> |
| <DL> |
| <DD>localization of the logging logic</DL> |
| <HR> |
| |
| <A NAME="logVMMessageWarn(java.lang.String)"><!-- --></A><H3> |
| logVMMessageWarn</H3> |
| <PRE> |
| private void <B>logVMMessageWarn</B>(java.lang.String s)</PRE> |
| <DL> |
| <DD>localization of the logging logic</DL> |
| <HR> |
| |
| <A NAME="isVelocimacro(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| isVelocimacro</H3> |
| <PRE> |
| public boolean <B>isVelocimacro</B>(java.lang.String vm, |
| java.lang.String sourceTemplate)</PRE> |
| <DL> |
| <DD>Tells the world if a given directive string is a Velocimacro</DL> |
| <HR> |
| |
| <A NAME="getVelocimacro(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getVelocimacro</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/velocity/runtime/directive/Directive.html">Directive</A> <B>getVelocimacro</B>(java.lang.String vmName, |
| java.lang.String sourceTemplate)</PRE> |
| <DL> |
| <DD>actual factory : creates a Directive that will |
| behave correctly wrt getting the framework to |
| dig out the correct # of args</DL> |
| <HR> |
| |
| <A NAME="dumpVMNamespace(java.lang.String)"><!-- --></A><H3> |
| dumpVMNamespace</H3> |
| <PRE> |
| public boolean <B>dumpVMNamespace</B>(java.lang.String namespace)</PRE> |
| <DL> |
| <DD>tells the vmManager to dump the specified namespace</DL> |
| <HR> |
| |
| <A NAME="setTemplateLocalInline(boolean)"><!-- --></A><H3> |
| setTemplateLocalInline</H3> |
| <PRE> |
| private void <B>setTemplateLocalInline</B>(boolean b)</PRE> |
| <DL> |
| <DD>sets permission to have VMs local in scope to their declaring template |
| note that this is really taken care of in the VMManager class, but |
| we need it here for gating purposes in addVM |
| eventually, I will slide this all into the manager, maybe.</DL> |
| <HR> |
| |
| <A NAME="getTemplateLocalInline()"><!-- --></A><H3> |
| getTemplateLocalInline</H3> |
| <PRE> |
| private boolean <B>getTemplateLocalInline</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="setAddMacroPermission(boolean)"><!-- --></A><H3> |
| setAddMacroPermission</H3> |
| <PRE> |
| private boolean <B>setAddMacroPermission</B>(boolean arg)</PRE> |
| <DL> |
| <DD>sets the permission to add new macros</DL> |
| <HR> |
| |
| <A NAME="setReplacementPermission(boolean)"><!-- --></A><H3> |
| setReplacementPermission</H3> |
| <PRE> |
| private boolean <B>setReplacementPermission</B>(boolean arg)</PRE> |
| <DL> |
| <DD>sets the permission for allowing addMacro() calls to |
| replace existing VM's</DL> |
| <HR> |
| |
| <A NAME="setBlather(boolean)"><!-- --></A><H3> |
| setBlather</H3> |
| <PRE> |
| private void <B>setBlather</B>(boolean b)</PRE> |
| <DL> |
| <DD>set output message mode</DL> |
| <HR> |
| |
| <A NAME="getBlather()"><!-- --></A><H3> |
| getBlather</H3> |
| <PRE> |
| private boolean <B>getBlather</B>()</PRE> |
| <DL> |
| <DD>get output message mode</DL> |
| <HR> |
| |
| <A NAME="setAutoload(boolean)"><!-- --></A><H3> |
| setAutoload</H3> |
| <PRE> |
| private void <B>setAutoload</B>(boolean b)</PRE> |
| <DL> |
| <DD>set the switch for automatic reloading of |
| global library-based VMs</DL> |
| <HR> |
| |
| <A NAME="getAutoload()"><!-- --></A><H3> |
| getAutoload</H3> |
| <PRE> |
| private boolean <B>getAutoload</B>()</PRE> |
| <DL> |
| <DD>get the switch for automatic reloading of |
| global library-based VMs</DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/VelocimacroFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/velocity/runtime/RuntimeSingleton.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/velocity/runtime/VelocimacroFactory.Twonk.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="VelocimacroFactory.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#inner_class_summary">INNER</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2002 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
