org.apache.velocity.tools
Class Toolbox

java.lang.Object
  extended by org.apache.velocity.tools.Toolbox
All Implemented Interfaces:
java.io.Serializable

public class Toolbox
extends java.lang.Object
implements java.io.Serializable

Version:
$Id: Toolbox.java 511959 2007-02-26 19:24:39Z nbubna $
Author:
Nathan Bubna
See Also:
Serialized Form

Field Summary
private  java.util.Map<java.lang.String,java.lang.Object> cache
           
private  java.util.Map<java.lang.String,ToolInfo> infoMap
           
private  java.util.Map<java.lang.String,java.lang.Object> properties
           
private static long serialVersionUID
           
 
Constructor Summary
Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo)
           
Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo, java.util.Map<java.lang.String,java.lang.Object> properties)
           
 
Method Summary
protected  void cacheData(java.util.Map<java.lang.String,java.lang.Object> data)
           
 Toolbox combine(Toolbox... toolboxes)
          Returns a new Toolbox that is a combination of this toolbox with one or more specified Toolboxes.
 java.lang.Object get(java.lang.String key)
           
 java.lang.Object get(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.lang.Object get(java.lang.String key, java.lang.String path)
           
 java.lang.Object get(java.lang.String key, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.util.Map<java.lang.String,java.lang.Object> getAll(java.util.Map<java.lang.String,java.lang.Object> context)
           
protected  java.lang.Object getFromCache(java.lang.String key, java.lang.String path)
           
protected  java.lang.Object getFromInfo(java.lang.String key, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> context)
           
 java.util.Set<java.lang.String> getKeys()
           
 java.util.Map<java.lang.String,java.lang.Object> getProperties()
           
protected  boolean hasPermission(ToolInfo info, java.lang.String path)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

infoMap

private java.util.Map<java.lang.String,ToolInfo> infoMap

properties

private java.util.Map<java.lang.String,java.lang.Object> properties

cache

private java.util.Map<java.lang.String,java.lang.Object> cache
Constructor Detail

Toolbox

public Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo)

Toolbox

public Toolbox(java.util.Map<java.lang.String,ToolInfo> toolInfo,
               java.util.Map<java.lang.String,java.lang.Object> properties)
Method Detail

cacheData

protected void cacheData(java.util.Map<java.lang.String,java.lang.Object> data)

getProperties

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

get

public java.lang.Object get(java.lang.String key)

get

public java.lang.Object get(java.lang.String key,
                            java.lang.String path)

get

public java.lang.Object get(java.lang.String key,
                            java.util.Map<java.lang.String,java.lang.Object> context)

get

public java.lang.Object get(java.lang.String key,
                            java.lang.String path,
                            java.util.Map<java.lang.String,java.lang.Object> context)

getFromCache

protected java.lang.Object getFromCache(java.lang.String key,
                                        java.lang.String path)

getFromInfo

protected java.lang.Object getFromInfo(java.lang.String key,
                                       java.lang.String path,
                                       java.util.Map<java.lang.String,java.lang.Object> context)

hasPermission

protected boolean hasPermission(ToolInfo info,
                                java.lang.String path)

getKeys

public java.util.Set<java.lang.String> getKeys()

getAll

public java.util.Map<java.lang.String,java.lang.Object> getAll(java.util.Map<java.lang.String,java.lang.Object> context)

combine

public Toolbox combine(Toolbox... toolboxes)
Returns a new Toolbox that is a combination of this toolbox with one or more specified Toolboxes.



Copyright (c) 2003-2007 Apache Software Foundation