OgnlContext (OGNL - Object Graph Navigation Library 3.2.6 API)

java.lang.Object
- ognl.OgnlContext

All Implemented Interfaces:

java.util.Map
```
public class OgnlContext
extends java.lang.Object
implements java.util.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
  java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`KEEP_LAST_EVALUATION_CONTEXT_KEY`
`static java.lang.String`	`LAST_EVALUATION_CONTEXT_KEY`
`static java.lang.String`	`ROOT_CONTEXT_KEY`
`static java.lang.String`	`THIS_CONTEXT_KEY`
`static java.lang.String`	`TRACE_EVALUATIONS_CONTEXT_KEY`
`static java.lang.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(java.util.Map values)` Deprecated. use on of the constructors which require `MemberAccess`, this one can be removed soon
`OgnlContext(MemberAccess memberAccess, ClassResolver classResolver, TypeConverter typeConverter, java.util.Map values)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLocalReference(java.lang.String key, LocalReference reference)`
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set`	`entrySet()`
`boolean`	`equals(java.lang.Object o)`
`java.lang.Object`	`get(java.lang.Object key)`
`ClassResolver`	`getClassResolver()`
`java.lang.Class`	`getCurrentAccessor()`
`Evaluation`	`getCurrentEvaluation()` Gets the current Evaluation from the top of the stack.
`Node`	`getCurrentNode()`
`java.lang.Object`	`getCurrentObject()`
`java.lang.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.
`java.lang.Class`	`getFirstAccessor()`
`java.lang.Class`	`getFirstType()`
`boolean`	`getKeepLastEvaluation()` Returns true if the last evaluation that was done on this context is retained and available through `getLastEvaluation()`.
`Evaluation`	`getLastEvaluation()`
`java.util.Map`	`getLocalReferences()`
`MemberAccess`	`getMemberAccess()`
`java.lang.Class`	`getPreviousAccessor()`
`java.lang.Class`	`getPreviousType()` Represents the last known object type on the evaluation stack, will be the value of the last known `getCurrentType()`.
`java.lang.Object`	`getRoot()`
`Evaluation`	`getRootEvaluation()` Gets the root of the evaluation stack.
`boolean`	`getTraceEvaluations()`
`TypeConverter`	`getTypeConverter()`
`java.util.Map`	`getValues()`
`int`	`hashCode()`
`int`	`incrementLocalReferenceCounter()`
`boolean`	`isEmpty()`
`java.util.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.
`java.lang.Object`	`put(java.lang.Object key, java.lang.Object value)`
`void`	`putAll(java.util.Map t)`
`void`	`recycleLastEvaluation()` Deprecated. since 3.2
`java.lang.Object`	`remove(java.lang.Object key)`
`void`	`setClassResolver(ClassResolver ignore)` Deprecated.
`void`	`setCurrentAccessor(java.lang.Class type)`
`void`	`setCurrentEvaluation(Evaluation value)`
`void`	`setCurrentNode(Node value)`
`void`	`setCurrentObject(java.lang.Object value)`
`void`	`setCurrentType(java.lang.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(java.lang.Class type)`
`void`	`setRoot(java.lang.Object value)`
`void`	`setRootEvaluation(Evaluation value)`
`void`	`setTraceEvaluations(boolean value)`
`void`	`setTypeConverter(TypeConverter ignore)` Deprecated.
`void`	`setValues(java.util.Map value)`
`int`	`size()`
`java.util.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 java.lang.String ROOT_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - THIS_CONTEXT_KEY
```
public static final java.lang.String THIS_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - TRACE_EVALUATIONS_CONTEXT_KEY
```
public static final java.lang.String TRACE_EVALUATIONS_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - LAST_EVALUATION_CONTEXT_KEY
```
public static final java.lang.String LAST_EVALUATION_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - KEEP_LAST_EVALUATION_CONTEXT_KEY
```
public static final java.lang.String KEEP_LAST_EVALUATION_CONTEXT_KEY
```
    See Also:
    Constant Field Values
  - TYPE_CONVERTER_CONTEXT_KEY
```
@Deprecated
public static final java.lang.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.
  - OgnlContext
```
@Deprecated
public OgnlContext(java.util.Map values)
```
    Deprecated. use on of the constructors which require MemberAccess, this one can be removed soon
  - OgnlContext
```
public OgnlContext(MemberAccess memberAccess,
           ClassResolver classResolver,
           TypeConverter typeConverter,
           java.util.Map values)
```
- Method Detail
  - setValues
```
public void setValues(java.util.Map value)
```
  - getValues
```
public java.util.Map getValues()
```
  - 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(java.lang.Object value)
```
  - getRoot
```
public java.lang.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.
  - 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.
  - setCurrentObject
```
public void setCurrentObject(java.lang.Object value)
```
  - getCurrentObject
```
public java.lang.Object getCurrentObject()
```
  - setCurrentAccessor
```
public void setCurrentAccessor(java.lang.Class type)
```
  - getCurrentAccessor
```
public java.lang.Class getCurrentAccessor()
```
  - getPreviousAccessor
```
public java.lang.Class getPreviousAccessor()
```
  - getFirstAccessor
```
public java.lang.Class getFirstAccessor()
```
  - getCurrentType
```
public java.lang.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(java.lang.Class type)
```
  - getPreviousType
```
public java.lang.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(java.lang.Class type)
```
  - getFirstType
```
public java.lang.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.
  - 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.
  - 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.
  - 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().
  - 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.
  - incrementLocalReferenceCounter
```
public int incrementLocalReferenceCounter()
```
  - addLocalReference
```
public void addLocalReference(java.lang.String key,
                     LocalReference reference)
```
  - getLocalReferences
```
public java.util.Map getLocalReferences()
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map
  - get
```
public java.lang.Object get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map
  - put
```
public java.lang.Object put(java.lang.Object key,
                   java.lang.Object value)
```
    Specified by:
    
    put in interface java.util.Map
  - remove
```
public java.lang.Object remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map
  - putAll
```
public void putAll(java.util.Map t)
```
    Specified by:
    
    putAll in interface java.util.Map
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map
  - keySet
```
public java.util.Set keySet()
```
    Specified by:
    
    keySet in interface java.util.Map
  - values
```
public java.util.Collection values()
```
    Specified by:
    
    values in interface java.util.Map
  - entrySet
```
public java.util.Set entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map
  - equals
```
public boolean equals(java.lang.Object o)
```
    Specified by:
    
    equals in interface java.util.Map
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Map
    
    Overrides:
    
    hashCode in class java.lang.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

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