Class VelocimacroFactory

java.lang.Object
org.apache.velocity.runtime.VelocimacroFactory

public class VelocimacroFactory extends Object
VelocimacroFactory.java manages the set of VMs in a running Velocity engine.
Version:
$Id: VelocimacroFactory.java 894953 2009-12-31 22:48:19Z nbubna $
  • Field Details

    • rsvc

      private final RuntimeServices rsvc
      runtime services for this instance
    • log

      private final LogDisplayWrapper log
      the log for this instance
    • vmManager

      private VelocimacroManager vmManager
      VMManager : deal with namespace management and actually keeps all the VM definitions
    • replaceAllowed

      private boolean replaceAllowed
      determines if replacement of global VMs are allowed controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL
    • addNewAllowed

      private boolean addNewAllowed
      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
    • templateLocal

      private boolean templateLocal
      sets if template-local namespace in used
    • autoReloadLibrary

      private boolean autoReloadLibrary
      determines if the libraries are auto-loaded when they change
    • macroLibVec

      private List macroLibVec
      vector of the library names
    • libModMap

      private Map libModMap
      map of the library Template objects used for reload determination
  • Constructor Details

    • VelocimacroFactory

      public VelocimacroFactory(RuntimeServices rsvc)
      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 AST
      argArray - 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

      private boolean canAddVelocimacro(String name, String sourceTemplate)
      determines if a given macro/namespace (name, source) combo is allowed to be added
      Parameters:
      name - Name of VM to add
      sourceTemplate - Source template that contains the defintion of the VM
      Returns:
      true if it is allowed to be added, false otherwise
    • isVelocimacro

      public boolean isVelocimacro(String vm, String sourceTemplate)
      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

      public Directive getVelocimacro(String vmName, String sourceTemplate)
      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

      public Directive getVelocimacro(String vmName, String sourceTemplate, String renderingTemplate)
      Since:
      1.6
    • dumpVMNamespace

      public boolean dumpVMNamespace(String namespace)
      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