Package org.apache.velocity.runtime

Class VelocimacroManager

java.lang.Object
org.apache.velocity.runtime.VelocimacroManager
public class VelocimacroManager extends Object
Manages VMs in namespaces. Currently, two namespace modes are supported:
  • flat - all allowable VMs are in the global namespace
  • local - inline VMs are added to it's own template namespace
Thanks to Jose Alberto Fernandez for some ideas incorporated here.
Version:
$Id: VelocimacroManager.java 992115 2010-09-02 21:00:10Z nbubna $

  • Field Details

    • GLOBAL_NAMESPACE

      private static String GLOBAL_NAMESPACE

    • registerFromLib

      private boolean registerFromLib

    • namespaceHash

      private final Map namespaceHash
      Hash of namespace hashes.

    • globalNamespace

      private final Map globalNamespace
      reference to global namespace hash

    • libraries

      private final Set libraries
      set of names of library tempates/namespaces

    • rsvc

      private RuntimeServices rsvc

    • namespacesOn

      private boolean namespacesOn

    • inlineLocalMode

      private boolean inlineLocalMode

    • inlineReplacesGlobal

      private boolean inlineReplacesGlobal

  • Constructor Details

    • VelocimacroManager

      VelocimacroManager(RuntimeServices rsvc)
      Adds the global namespace to the hash.

  • Method Details

    • addVM

      public boolean addVM(String vmName, Node macroBody, String[] argArray, String namespace, boolean canReplaceGlobalMacro)
      Adds a VM definition to the cache. Called by VelocimacroFactory.addVelociMacro (after parsing and discovery in Macro directive)
      Parameters:
      vmName - Name of the new VelociMacro.
      macroBody - String representation of the macro body.
      argArray - Array of macro parameters, first parameter is the macro name.
      namespace - The namespace/template from which this macro has been loaded.
      Returns:
      Whether everything went okay.

    • get

      public VelocimacroProxy get(String vmName, String namespace)
      Gets a VelocimacroProxy object by the name / source template duple.
      Parameters:
      vmName - Name of the VelocityMacro to look up.
      namespace - Namespace in which to look up the macro.
      Returns:
      A proxy representing the Macro.

    • get

      public VelocimacroProxy get(String vmName, String namespace, String renderingTemplate)
      Gets a VelocimacroProxy object by the name / source template duple.
      Parameters:
      vmName - Name of the VelocityMacro to look up.
      namespace - Namespace in which to look up the macro.
      renderingTemplate - Name of the template we are currently rendering.
      Returns:
      A proxy representing the Macro.
      Since:
      1.6

    • dumpNamespace

      public boolean dumpNamespace(String namespace)
      Removes the VMs and the namespace from the manager. Used when a template is reloaded to avoid losing memory.
      Parameters:
      namespace - namespace to dump
      Returns:
      boolean representing success

    • setNamespaceUsage

      public void setNamespaceUsage(boolean namespaceOn)
      public switch to let external user of manager to control namespace usage indep of properties. That way, for example, at startup the library files are loaded into global namespace
      Parameters:
      namespaceOn - True if namespaces should be used.

    • setRegisterFromLib

      public void setRegisterFromLib(boolean registerFromLib)
      Should macros registered from Libraries be marked special?
      Parameters:
      registerFromLib - True if macros from Libs should be marked.

    • setTemplateLocalInlineVM

      public void setTemplateLocalInlineVM(boolean inlineLocalMode)
      Should macros from the same template be inlined?
      Parameters:
      inlineLocalMode - True if macros should be inlined on the same template.

    • getNamespace

      private Map getNamespace(String namespace, boolean addIfNew)
      returns the hash for the specified namespace, and if it doesn't exist will create a new one and add it to the namespaces
      Parameters:
      namespace - name of the namespace :)
      addIfNew - flag to add a new namespace if it doesn't exist
      Returns:
      namespace Map of VMs or null if doesn't exist

    • addNamespace

      private Map addNamespace(String namespace)
      adds a namespace to the namespaces
      Parameters:
      namespace - name of namespace to add
      Returns:
      Hash added to namespaces, ready for use

    • usingNamespaces

      private boolean usingNamespaces(String namespace)
      determines if currently using namespaces.
      Parameters:
      namespace - currently ignored
      Returns:
      true if using namespaces, false if not

    • getLibraryName

      public String getLibraryName(String vmName, String namespace)
      Return the library name for a given macro.
      Parameters:
      vmName - Name of the Macro to look up.
      namespace - Namespace to look the macro up.
      Returns:
      The name of the library which registered this macro in a namespace.

    • setInlineReplacesGlobal

      public void setInlineReplacesGlobal(boolean is)
      Since:
      1.6