Package org.apache.velocity.tools

Class ToolboxFactory

  • public class ToolboxFactory
extends java.lang.Object

    This class is the central point of action for VelocityTools. It manages the configured and scoped ToolInfo and Data and is meant to stick around for the life of the application.

    It works like this:

    1. Build up your FactoryConfiguration(s)
    2. Create a ToolboxFactory instance
    3. Pass the configuration to configure(org.apache.velocity.tools.config.FactoryConfiguration)
    4. When appropriate for each scope, use createToolbox(java.lang.String) to create the Toolbox for that scope and put that toolbox somewhere appropriate to that scope.
    5. When you want a tool, get that Toolbox and ask it for the tool you want (e.g. toolbox.get("math")).

    Of course, most users will not have to do any of this as much of it is handled for them by some combination of ToolManager or org.apache.velocity.tools.view.VelocityView and a ToolContext or org.apache.velocity.tools.view.ViewToolContext.

    NOTE: While you are free to pass in new configuration info at any time, that data will only affect Toolboxes created subsequently. Any previously created toolboxes will have to be re-created and replaced to reflect the changes to the configuration.

    Version:
    $Id: ToolboxFactory.java 511959 2007-02-26 19:24:39Z nbubna $
    Author:
    Nathan Bubna

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_SCOPE  

    • Constructor Summary

      Constructors 
      Constructor Description
      ToolboxFactory()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addToolInfo​(java.lang.String scope, ToolInfo tool)  
      void configure​(FactoryConfiguration config)  
      Toolbox createToolbox​(java.lang.String scope)  
      java.util.Map<java.lang.String,​java.lang.Object> getData()  
      java.lang.Object getGlobalProperty​(java.lang.String name)  
      protected java.util.Map<java.lang.String,​ToolInfo> getToolInfo​(java.lang.String scope)  
      boolean hasTools​(java.lang.String scope)  
      protected java.lang.Object putData​(java.lang.String key, java.lang.Object value)  
      protected void putGlobalProperties​(java.util.Map<java.lang.String,​java.lang.Object> props)  
      protected void putProperties​(java.lang.String scope, java.util.Map<java.lang.String,​java.lang.Object> props)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ToolboxFactory

        public ToolboxFactory()

    • Method Detail

      • putData

        protected java.lang.Object putData​(java.lang.String key,
                                   java.lang.Object value)

      • addToolInfo

        protected void addToolInfo​(java.lang.String scope,
                           ToolInfo tool)

      • getToolInfo

        protected java.util.Map<java.lang.String,​ToolInfo> getToolInfo​(java.lang.String scope)

      • putGlobalProperties

        protected void putGlobalProperties​(java.util.Map<java.lang.String,​java.lang.Object> props)

      • putProperties

        protected void putProperties​(java.lang.String scope,
                             java.util.Map<java.lang.String,​java.lang.Object> props)

      • getGlobalProperty

        public java.lang.Object getGlobalProperty​(java.lang.String name)

      • getData

        public java.util.Map<java.lang.String,​java.lang.Object> getData()

      • hasTools

        public boolean hasTools​(java.lang.String scope)

      • createToolbox

        public Toolbox createToolbox​(java.lang.String scope)