Package org.apache.velocity.runtime
Class VelocimacroFactory
java.lang.Object
org.apache.velocity.runtime.VelocimacroFactory
VelocimacroFactory.java
manages the set of VMs in a running Velocity engine.
- Version:
- $Id: VelocimacroFactory.java 894953 2009-12-31 22:48:19Z nbubna $
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
small container class to hold the tuple of a template and modification time. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
controls if new VMs can be added.private boolean
determines if the libraries are auto-loaded when they changeprivate Map
map of the library Template objects used for reload determinationprivate final LogDisplayWrapper
the log for this instanceprivate List
vector of the library namesprivate boolean
determines if replacement of global VMs are allowed controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBALprivate final RuntimeServices
runtime services for this instanceprivate boolean
sets if template-local namespace in usedprivate VelocimacroManager
VMManager : deal with namespace management and actually keeps all the VM definitions -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
addVelocimacro
(String name, String macroBody, String[] argArray, String sourceTemplate) Adds a macro to the factory.boolean
addVelocimacro
(String name, Node macroBody, String[] argArray, String sourceTemplate) Adds a macro to the factory.private boolean
canAddVelocimacro
(String name, String sourceTemplate) determines if a given macro/namespace (name, source) combo is allowed to be addedboolean
dumpVMNamespace
(String namespace) tells the vmManager to dump the specified namespaceprivate boolean
get the switch for automatic reloading of global library-based VMsprivate boolean
getVelocimacro
(String vmName, String sourceTemplate) actual factory : creates a Directive that will behave correctly wrt getting the framework to dig out the correct # of argsgetVelocimacro
(String vmName, String sourceTemplate, String renderingTemplate) void
initialize the factory - setup all permissions load all global libraries.boolean
isVelocimacro
(String vm, String sourceTemplate) Tells the world if a given directive string is a Velocimacroprivate boolean
setAddMacroPermission
(boolean addNewAllowed) sets the permission to add new macrosprivate void
setAutoload
(boolean b) set the switch for automatic reloading of global library-based VMsprivate boolean
setReplacementPermission
(boolean arg) sets the permission for allowing addMacro() calls to replace existing VM'sprivate void
setTemplateLocalInline
(boolean b) 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.
-
Field Details
-
rsvc
runtime services for this instance -
log
the log for this instance -
vmManager
VMManager : deal with namespace management and actually keeps all the VM definitions -
replaceAllowed
private boolean replaceAlloweddetermines if replacement of global VMs are allowed controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL -
addNewAllowed
private boolean addNewAllowedcontrols 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 -
templateLocal
private boolean templateLocalsets if template-local namespace in used -
autoReloadLibrary
private boolean autoReloadLibrarydetermines if the libraries are auto-loaded when they change -
macroLibVec
vector of the library names -
libModMap
map of the library Template objects used for reload determination
-
-
Constructor Details
-
VelocimacroFactory
C'tor for the VelociMacro factory.- Parameters:
rsvc
- Reference to a runtime services object.
-
-
Method Details
-
initVelocimacro
public void initVelocimacro()initialize the factory - setup all permissions load all global libraries. -
addVelocimacro
public boolean addVelocimacro(String name, String macroBody, String[] argArray, String sourceTemplate) Adds a macro to the factory. addVelocimacro(String, Node, String[] argArray, String) should be used internally instead of this.- Parameters:
name
- Name of the Macro to add.macroBody
- String representation of the macro.argArray
- Macro arguments. First element is the macro name.sourceTemplate
- Source template from which the macro gets registered.- Returns:
- true if Macro was registered successfully.
-
addVelocimacro
public boolean addVelocimacro(String name, Node macroBody, String[] argArray, String sourceTemplate) Adds a macro to the factory.- Parameters:
name
- Name of the Macro to add.macroBody
- root node of the parsed macro ASTargArray
- Name of the macro arguments. First element is the macro name.sourceTemplate
- Source template from which the macro gets registered.- Returns:
- true if Macro was registered successfully.
- Since:
- 1.6
-
canAddVelocimacro
determines if a given macro/namespace (name, source) combo is allowed to be added- Parameters:
name
- Name of VM to addsourceTemplate
- Source template that contains the defintion of the VM- Returns:
- true if it is allowed to be added, false otherwise
-
isVelocimacro
Tells the world if a given directive string is a Velocimacro- Parameters:
vm
- Name of the Macro.sourceTemplate
- Source template from which the macro should be loaded.- Returns:
- True if the given name is a macro.
-
getVelocimacro
actual factory : creates a Directive that will behave correctly wrt getting the framework to dig out the correct # of args- Parameters:
vmName
- Name of the Macro.sourceTemplate
- Source template from which the macro should be loaded.- Returns:
- A directive representing the Macro.
-
getVelocimacro
- Since:
- 1.6
-
dumpVMNamespace
tells the vmManager to dump the specified namespace- Parameters:
namespace
- Namespace to dump.- Returns:
- True if namespace has been dumped successfully.
-
setTemplateLocalInline
private void setTemplateLocalInline(boolean b) 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. -
getTemplateLocalInline
private boolean getTemplateLocalInline() -
setAddMacroPermission
private boolean setAddMacroPermission(boolean addNewAllowed) sets the permission to add new macros -
setReplacementPermission
private boolean setReplacementPermission(boolean arg) sets the permission for allowing addMacro() calls to replace existing VM's -
setAutoload
private void setAutoload(boolean b) set the switch for automatic reloading of global library-based VMs -
getAutoload
private boolean getAutoload()get the switch for automatic reloading of global library-based VMs
-