OgnlContext (OGNL - Object Graph Navigation Library 3.2.21 API)

java.lang.Object
- ognl.OgnlContext

All Implemented Interfaces:

Map
```
public class OgnlContext
extends Object
implements Map
```
This class defines the execution context for an OGNL expression

Author:

Luke Blanshard (blanshlu@netscape.net), Drew Davidson (drew@ognl.org)

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEEP_LAST_EVALUATION_CONTEXT_KEY`
`static String`	`LAST_EVALUATION_CONTEXT_KEY`
`static String`	`ROOT_CONTEXT_KEY`
`static String`	`THIS_CONTEXT_KEY`
`static String`	`TRACE_EVALUATIONS_CONTEXT_KEY`
`static String`	`TYPE_CONVERTER_CONTEXT_KEY` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`OgnlContext(ClassResolver classResolver, TypeConverter typeConverter, MemberAccess memberAccess)` Constructs a new OgnlContext with the given class resolver, type converter and member access.
`OgnlContext(MemberAccess memberAccess, ClassResolver classResolver, TypeConverter typeConverter, Map values)` Constructs a new OgnlContext with the given member access, class resolver, type converter and values.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLocalReference(String key, LocalReference reference)`
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set`	`entrySet()`
`boolean`	`equals(Object o)`
`Object`	`get(Object key)`
`ClassResolver`	`getClassResolver()`
`Class`	`getCurrentAccessor()`
`Evaluation`	`getCurrentEvaluation()` Gets the current Evaluation from the top of the stack.
`Node`	`getCurrentNode()`
`Object`	`getCurrentObject()`
`Class`	`getCurrentType()` Gets the current class type being evaluated on the stack, as set by `setCurrentType(Class)`.
`Evaluation`	`getEvaluation(int relativeIndex)` Returns the Evaluation at the relative index given.
`Class`	`getFirstAccessor()`
`Class`	`getFirstType()`
`boolean`	`getKeepLastEvaluation()` Returns true if the last evaluation that was done on this context is retained and available through `getLastEvaluation()`.
`Evaluation`	`getLastEvaluation()`
`Map`	`getLocalReferences()`
`MemberAccess`	`getMemberAccess()`
`Class`	`getPreviousAccessor()`
`Class`	`getPreviousType()` Represents the last known object type on the evaluation stack, will be the value of the last known `getCurrentType()`.
`Object`	`getRoot()`
`Evaluation`	`getRootEvaluation()` Gets the root of the evaluation stack.
`boolean`	`getTraceEvaluations()`
`TypeConverter`	`getTypeConverter()`
`Map`	`getValues()` Get the values Map for this OgnlContext.
`int`	`hashCode()`
`int`	`incrementLocalReferenceCounter()`
`boolean`	`isEmpty()`
`Set`	`keySet()`
`Evaluation`	`popEvaluation()` Pops the current Evaluation off of the top of the stack.
`void`	`pushEvaluation(Evaluation value)` Pushes a new Evaluation onto the stack.
`Object`	`put(Object key, Object value)`
`void`	`putAll(Map t)`
`void`	`recycleLastEvaluation()` Deprecated. since 3.2
`Object`	`remove(Object key)`
`void`	`setClassResolver(ClassResolver ignore)` Deprecated.
`void`	`setCurrentAccessor(Class type)`
`void`	`setCurrentEvaluation(Evaluation value)`
`void`	`setCurrentNode(Node value)`
`void`	`setCurrentObject(Object value)`
`void`	`setCurrentType(Class type)`
`void`	`setKeepLastEvaluation(boolean value)` Sets whether the last evaluation that was done on this context is retained and available through `getLastEvaluation()`.
`void`	`setLastEvaluation(Evaluation value)`
`void`	`setMemberAccess(MemberAccess ignore)` Deprecated.
`void`	`setPreviousType(Class type)`
`void`	`setRoot(Object value)`
`void`	`setRootEvaluation(Evaluation value)`
`void`	`setTraceEvaluations(boolean value)`
`void`	`setTypeConverter(TypeConverter ignore)` Deprecated.
`void`	`setValues(Map value)` Set (put) the provided value map content into the existing values Map for this OgnlContext.
`int`	`size()`
`Collection`	`values()`

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

- Field Detail
  - ROOT_CONTEXT_KEY
```
public static final String ROOT_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - THIS_CONTEXT_KEY
```
public static final String THIS_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - TRACE_EVALUATIONS_CONTEXT_KEY
```
public static final String TRACE_EVALUATIONS_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - LAST_EVALUATION_CONTEXT_KEY
```
public static final String LAST_EVALUATION_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - KEEP_LAST_EVALUATION_CONTEXT_KEY
```
public static final String KEEP_LAST_EVALUATION_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - TYPE_CONVERTER_CONTEXT_KEY
```
@Deprecated
public static final String TYPE_CONVERTER_CONTEXT_KEY
```
    Deprecated.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - OgnlContext
```
public OgnlContext(ClassResolver classResolver,
           TypeConverter typeConverter,
           MemberAccess memberAccess)
```
    Constructs a new OgnlContext with the given class resolver, type converter and member access. If any of these parameters is null the default will be used, except memberAccess which must be non-null.
    
    Parameters:
    classResolver - the ClassResolver for a new OgnlContext.
    typeConverter - the TypeConverter for a new OgnlContext.
    memberAccess - the MemberAccess for a new OgnlContext. Must be non-null.
  - OgnlContext
```
public OgnlContext(MemberAccess memberAccess,
           ClassResolver classResolver,
           TypeConverter typeConverter,
           Map values)
```
    Constructs a new OgnlContext with the given member access, class resolver, type converter and values. If any of these parameters is null the default will be used, except memberAccess which must be non-null.
    
    Parameters:
    memberAccess - the MemberAccess for a new OgnlContext. Must be non-null.
    classResolver - the ClassResolver for a new OgnlContext.
    typeConverter - the TypeConverter for a new OgnlContext.
    values - the Map of values to provide for a new OgnlContext.
- Method Detail
  - setValues
```
public void setValues(Map value)
```
    Set (put) the provided value map content into the existing values Map for this OgnlContext.
    
    Parameters:
    value - a Map of additional values to put into this OgnlContext.
  - getValues
```
public Map getValues()
```
    Get the values Map for this OgnlContext.
    
    Returns:
    Map of values for this OgnlContext.
  - setClassResolver
```
@Deprecated
public void setClassResolver(ClassResolver ignore)
```
    Deprecated.
  - getClassResolver
```
public ClassResolver getClassResolver()
```
  - setTypeConverter
```
@Deprecated
public void setTypeConverter(TypeConverter ignore)
```
    Deprecated.
  - getTypeConverter
```
public TypeConverter getTypeConverter()
```
  - setMemberAccess
```
@Deprecated
public void setMemberAccess(MemberAccess ignore)
```
    Deprecated.
  - getMemberAccess
```
public MemberAccess getMemberAccess()
```
  - setRoot
```
public void setRoot(Object value)
```
  - getRoot
```
public Object getRoot()
```
  - getTraceEvaluations
```
public boolean getTraceEvaluations()
```
  - setTraceEvaluations
```
public void setTraceEvaluations(boolean value)
```
  - getLastEvaluation
```
public Evaluation getLastEvaluation()
```
  - setLastEvaluation
```
public void setLastEvaluation(Evaluation value)
```
  - recycleLastEvaluation
```
@Deprecated
public void recycleLastEvaluation()
```
    Deprecated. since 3.2
    
    This method can be called when the last evaluation has been used and can be returned for reuse in the free pool maintained by the runtime. This is not a necessary step, but is useful for keeping memory usage down. This will recycle the last evaluation and then set the last evaluation to null.
  - getKeepLastEvaluation
```
public boolean getKeepLastEvaluation()
```
    Returns true if the last evaluation that was done on this context is retained and available through getLastEvaluation(). The default is true.
    
    Returns:
    true if the last evaluation for this context is retained and available through getLastEvaluation(), false otherwise.
  - setKeepLastEvaluation
```
public void setKeepLastEvaluation(boolean value)
```
    Sets whether the last evaluation that was done on this context is retained and available through getLastEvaluation(). The default is true.
    
    Parameters:
    value - true if the last evaluation for this context should be retained and available through getLastEvaluation(), false otherwise.
  - setCurrentObject
```
public void setCurrentObject(Object value)
```
  - getCurrentObject
```
public Object getCurrentObject()
```
  - setCurrentAccessor
```
public void setCurrentAccessor(Class type)
```
  - getCurrentAccessor
```
public Class getCurrentAccessor()
```
  - getPreviousAccessor
```
public Class getPreviousAccessor()
```
  - getFirstAccessor
```
public Class getFirstAccessor()
```
  - getCurrentType
```
public Class getCurrentType()
```
    Gets the current class type being evaluated on the stack, as set by setCurrentType(Class).
    
    Returns:
    The current object type, may be null.
  - setCurrentType
```
public void setCurrentType(Class type)
```
  - getPreviousType
```
public Class getPreviousType()
```
    Represents the last known object type on the evaluation stack, will be the value of the last known getCurrentType().
    
    Returns:
    The previous type of object on the stack, may be null.
  - setPreviousType
```
public void setPreviousType(Class type)
```
  - getFirstType
```
public Class getFirstType()
```
  - setCurrentNode
```
public void setCurrentNode(Node value)
```
  - getCurrentNode
```
public Node getCurrentNode()
```
  - getCurrentEvaluation
```
public Evaluation getCurrentEvaluation()
```
    Gets the current Evaluation from the top of the stack. This is the Evaluation that is in process of evaluating.
    
    Returns:
    the current Evaluation from the top of the stack (being evaluated).
  - setCurrentEvaluation
```
public void setCurrentEvaluation(Evaluation value)
```
  - getRootEvaluation
```
public Evaluation getRootEvaluation()
```
    Gets the root of the evaluation stack. This Evaluation contains the node representing the root expression and the source is the root source object.
    
    Returns:
    the root Evaluation from the stack (the root expression node).
  - setRootEvaluation
```
public void setRootEvaluation(Evaluation value)
```
  - getEvaluation
```
public Evaluation getEvaluation(int relativeIndex)
```
    Returns the Evaluation at the relative index given. This should be zero or a negative number as a relative reference back up the evaluation stack. Therefore getEvaluation(0) returns the current Evaluation.
    
    Parameters:
    relativeIndex - the relative index for the Evaluation to retrieve from the stack (with 0 being the current Evaluation). relativeIndex should be <= 0.
    
    Returns:
    the Evaluation at relativeIndex, or null if relativeIndex is > 0.
  - pushEvaluation
```
public void pushEvaluation(Evaluation value)
```
    Pushes a new Evaluation onto the stack. This is done before a node evaluates. When evaluation is complete it should be popped from the stack via popEvaluation().
    
    Parameters:
    value - the Evaluation to push onto the stack.
  - popEvaluation
```
public Evaluation popEvaluation()
```
    Pops the current Evaluation off of the top of the stack. This is done after a node has completed its evaluation.
    
    Returns:
    the Evaluation popped from the top of the stack.
  - incrementLocalReferenceCounter
```
public int incrementLocalReferenceCounter()
```
  - addLocalReference
```
public void addLocalReference(String key,
                     LocalReference reference)
```
  - getLocalReferences
```
public Map getLocalReferences()
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map
  - put
```
public Object put(Object key,
         Object value)
```
    Specified by:
    
    put in interface Map
  - remove
```
public Object remove(Object key)
```
    Specified by:
    
    remove in interface Map
  - putAll
```
public void putAll(Map t)
```
    Specified by:
    
    putAll in interface Map
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map
  - keySet
```
public Set keySet()
```
    Specified by:
    
    keySet in interface Map
  - values
```
public Collection values()
```
    Specified by:
    
    values in interface Map
  - entrySet
```
public Set entrySet()
```
    Specified by:
    
    entrySet in interface Map
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map
    
    Overrides:
    
    hashCode in class Object

Class OgnlContext

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_CONTEXT_KEY

THIS_CONTEXT_KEY

TRACE_EVALUATIONS_CONTEXT_KEY

LAST_EVALUATION_CONTEXT_KEY

KEEP_LAST_EVALUATION_CONTEXT_KEY

TYPE_CONVERTER_CONTEXT_KEY

Constructor Detail

OgnlContext

OgnlContext

Method Detail

setValues

getValues

setClassResolver

getClassResolver

setTypeConverter

getTypeConverter

setMemberAccess

getMemberAccess

setRoot

getRoot

getTraceEvaluations

setTraceEvaluations

getLastEvaluation

setLastEvaluation

recycleLastEvaluation

getKeepLastEvaluation

setKeepLastEvaluation

setCurrentObject

getCurrentObject

setCurrentAccessor

getCurrentAccessor

getPreviousAccessor

getFirstAccessor

getCurrentType

setCurrentType

getPreviousType

setPreviousType

getFirstType

setCurrentNode

getCurrentNode

getCurrentEvaluation

setCurrentEvaluation

getRootEvaluation

setRootEvaluation

getEvaluation

pushEvaluation

popEvaluation

incrementLocalReferenceCounter

addLocalReference

getLocalReferences

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

equals

hashCode