ContextTool (VelocityTools 2.0 Documentation)

java.lang.Object
- org.apache.velocity.tools.generic.SafeConfig
- - org.apache.velocity.tools.generic.ContextTool

Direct Known Subclasses:: ViewContextTool

@DefaultKey(value="context")
 @InvalidScope(value={"application","session"})
public class ContextTool
extends SafeConfig

Tool for convenient access to Context data and meta-data.

 Template example(s):
  #foreach( $key in $context.keys )
    $key = $context.get($key)
  #end

 Toolbox configuration:
 <tools>
   <toolbox scope="request">
     <tool class="org.apache.velocity.tools.generic.ContextTool"/>
   </toolbox>
 </tools>

This class is only designed for use as a request-scope tool.

Since:: VelocityTools 2.0
Version:: $Id: ContextTool.java 385122 2006-03-11 18:37:42Z nbubna $
Author:: Nathan Bubna

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.velocity.context.Context context

protected java.util.Map<java.lang.String,java.lang.Object> toolbox
- Fields inherited from class org.apache.velocity.tools.generic.SafeConfig
  LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY

Fields
Modifier and Type	Field and Description
`protected org.apache.velocity.context.Context`	`context`
`protected java.util.Map<java.lang.String,java.lang.Object>`	`toolbox`

Constructor Summary

Constructors
Constructor and Description

ContextTool()

Constructors
Constructor and Description
`ContextTool()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`configure(ValueParser parser)` Initializes this instance for the current request.
`boolean`	`contains(java.lang.Object refName)` Returns `true` if the context contains a value for the specified reference name (aka context key).
`protected void`	`fillKeyset(java.util.Set keys)` Actually do the work of filling in the set of keys for `getKeys()` here so subclasses can add keys too.
`java.lang.Object`	`get(java.lang.Object refName)` Retrieves the value for the specified reference name (aka context key).
`java.util.Set`	`getKeys()` Return a `Set` of the available reference keys in the current context.
`org.apache.velocity.context.Context`	`getThis()` Returns the context being analyzed by this tool.
`java.util.Map<java.lang.String,java.lang.Object>`	`getToolbox()` Returns a read-only view of the toolbox `Map` for this context.
`java.util.Set`	`getValues()` Return a `Set` of the available values in the current context.

Methods inherited from class org.apache.velocity.tools.generic.SafeConfig
configure, isConfigLocked, isSafeMode, setLockConfig, setSafeMode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - context
```
protected org.apache.velocity.context.Context context
```
  - toolbox
```
protected java.util.Map<java.lang.String,java.lang.Object> toolbox
```
- Constructor Detail
  - ContextTool
```
public ContextTool()
```
- Method Detail
  - configure
```
protected void configure(ValueParser parser)
```
    Initializes this instance for the current request. Also looks for a safe-mode configuration setting. By default, safeMode is true and thus keys with '.' in them are hidden.
    
    Overrides:
    
    configure in class SafeConfig
  - getThis
```
public org.apache.velocity.context.Context getThis()
```
    Returns the context being analyzed by this tool.
  - getToolbox
```
public java.util.Map<java.lang.String,java.lang.Object> getToolbox()
```
    Returns a read-only view of the toolbox Map for this context.
    
    Returns:
    
    a map of all available tools for this request or null if such a map is not available
  - getKeys
```
public java.util.Set getKeys()
```
    Return a Set of the available reference keys in the current context.
  - fillKeyset
```
protected void fillKeyset(java.util.Set keys)
```
    Actually do the work of filling in the set of keys for getKeys() here so subclasses can add keys too.
  - getValues
```
public java.util.Set getValues()
```
    Return a Set of the available values in the current context.
  - contains
```
public boolean contains(java.lang.Object refName)
```
    Returns true if the context contains a value for the specified reference name (aka context key).
  - get
```
public java.lang.Object get(java.lang.Object refName)
```
    Retrieves the value for the specified reference name (aka context key).

Class ContextTool

Field Summary

Fields inherited from class org.apache.velocity.tools.generic.SafeConfig

Constructor Summary

Method Summary

Methods inherited from class org.apache.velocity.tools.generic.SafeConfig

Methods inherited from class java.lang.Object

Field Detail

context

toolbox

Constructor Detail

ContextTool

Method Detail

configure

getThis

getToolbox

getKeys

fillKeyset

getValues

contains

get