ContextTool (VelocityTools 2.0 Documentation)

java.lang.Object

org.apache.velocity.tools.generic.SafeConfig

org.apache.velocity.tools.generic.ContextTool

org.apache.velocity.tools.view.ViewContextTool

org.apache.velocity.tools.view.tools.ContextTool

@Deprecated public class ContextTool extends ViewContextTool

Deprecated.

Use ViewContextTool

Field Summary

Fields

Modifier and Type

Field

Description

static final String

OLD_SAFE_MODE_KEY

Deprecated.

Fields inherited from class org.apache.velocity.tools.view.ViewContextTool
application, request, session

Fields inherited from class org.apache.velocity.tools.generic.ContextTool
context, toolbox

Fields inherited from class org.apache.velocity.tools.generic.SafeConfig
LOCK_CONFIG_KEY, OLD_LOCK_CONFIG_KEY, SAFE_MODE_KEY
Constructor Summary

Constructors

Constructor

Description

ContextTool()

Deprecated.
Method Summary

Modifier and Type

Method

Description

void

configure(Map params)

Deprecated.

If SafeConfig.isConfigLocked() returns true, then this method does nothing; otherwise, if false, this will create a new ValueParser from the specified Map of params and call SafeConfig.configure(ValueParser) with it.

void

init(Object obj)

Deprecated.

Methods inherited from class org.apache.velocity.tools.view.ViewContextTool
configure, fillKeyset

Methods inherited from class org.apache.velocity.tools.generic.ContextTool
contains, get, getKeys, getThis, getToolbox, getValues

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

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

Field Details
- OLD_SAFE_MODE_KEY
  
  @Deprecated public static final String OLD_SAFE_MODE_KEY
  
  Deprecated.
  See Also:
  
  Constant Field Values
Constructor Details
- ContextTool
  
  public ContextTool()
  
  Deprecated.
Method Details
- init
  
  @Deprecated public void init(Object obj)
  
  Deprecated.
- configure
  
  public void configure(Map params)
  
  Deprecated.
  
  Description copied from class: SafeConfig
  
  If SafeConfig.isConfigLocked() returns true, then this method does nothing; otherwise, if false, this will create a new ValueParser from the specified Map of params and call SafeConfig.configure(ValueParser) with it. Then this will check the parameters itself to find out whether or not the configuration for this tool should be put into safe mode or have its config locked. The safe mode value should be a boolean under the key SafeConfig.SAFE_MODE_KEY and the lock value should be a boolean under the key SafeConfig.LOCK_CONFIG_KEY.
  
  Overrides:
  
  configure in class SafeConfig