Package org.apache.commons.ognl

Class OgnlContext

  • All Implemented Interfaces:
    java.util.Map<java.lang.String,​java.lang.Object>
    public class OgnlContext
extends java.lang.Object
implements java.util.Map<java.lang.String,​java.lang.Object>
    This class defines the execution context for an OGNL expression

    • Field Detail

      • CONTEXT_CONTEXT_KEY

        public static final java.lang.String CONTEXT_CONTEXT_KEY
        See Also:
        Constant Field Values

      • 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

      • CLASS_RESOLVER_CONTEXT_KEY

        public static final java.lang.String CLASS_RESOLVER_CONTEXT_KEY
        See Also:
        Constant Field Values

      • TYPE_CONVERTER_CONTEXT_KEY

        public static final java.lang.String TYPE_CONVERTER_CONTEXT_KEY
        See Also:
        Constant Field Values

      • MEMBER_ACCESS_CONTEXT_KEY

        public static final java.lang.String MEMBER_ACCESS_CONTEXT_KEY
        See Also:
        Constant Field Values

      • PROPERTY_KEY_PREFIX

        private static final java.lang.String PROPERTY_KEY_PREFIX
        See Also:
        Constant Field Values

      • defaultTraceEvaluations

        private static boolean defaultTraceEvaluations

      • defaultKeepLastEvaluation

        private static boolean defaultKeepLastEvaluation

      • DEFAULT_TYPE_CONVERTER

        public static final TypeConverter DEFAULT_TYPE_CONVERTER

      • DEFAULT_MEMBER_ACCESS

        public static final MemberAccess DEFAULT_MEMBER_ACCESS

      • RESERVED_KEYS

        private static final java.util.Set<java.lang.String> RESERVED_KEYS

      • root

        private java.lang.Object root

      • currentObject

        private java.lang.Object currentObject

      • currentNode

        private Node currentNode

      • traceEvaluations

        private boolean traceEvaluations

      • rootEvaluation

        private Evaluation rootEvaluation

      • currentEvaluation

        private Evaluation currentEvaluation

      • lastEvaluation

        private Evaluation lastEvaluation

      • keepLastEvaluation

        private boolean keepLastEvaluation

      • values

        private java.util.Map<java.lang.String,​java.lang.Object> values

      • typeStack

        private java.util.Stack<java.lang.Class<?>> typeStack

      • accessorStack

        private java.util.Stack<java.lang.Class<?>> accessorStack

      • localReferenceCounter

        private int localReferenceCounter

      • localReferenceMap

        private java.util.Map<java.lang.String,​LocalReference> localReferenceMap

    • Constructor Detail

      • OgnlContext

        public OgnlContext()
        Constructs a new OgnlContext with the default class resolver, type converter and member access.

      • 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

        public OgnlContext​(java.util.Map<java.lang.String,​java.lang.Object> values)

    • Method Detail

      • setValues

        public void setValues​(java.util.Map<java.lang.String,​java.lang.Object> value)

      • getValues

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

      • setClassResolver

        public void setClassResolver​(ClassResolver value)

      • setTypeConverter

        public void setTypeConverter​(TypeConverter value)

      • setMemberAccess

        public void setMemberAccess​(MemberAccess value)

      • 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

        public void recycleLastEvaluation()
        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<java.lang.String,​LocalReference> getLocalReferences()

      • size

        public int size()
        Specified by:
        size in interface java.util.Map<java.lang.String,​java.lang.Object>

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface java.util.Map<java.lang.String,​java.lang.Object>

      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Specified by:
        containsKey in interface java.util.Map<java.lang.String,​java.lang.Object>

      • containsValue

        public boolean containsValue​(java.lang.Object value)
        Specified by:
        containsValue in interface java.util.Map<java.lang.String,​java.lang.Object>

      • get

        public java.lang.Object get​(java.lang.Object key)
        Specified by:
        get in interface java.util.Map<java.lang.String,​java.lang.Object>

      • put

        public java.lang.Object put​(java.lang.String key,
                            java.lang.Object value)
        Specified by:
        put in interface java.util.Map<java.lang.String,​java.lang.Object>

      • remove

        public java.lang.Object remove​(java.lang.Object key)
        Specified by:
        remove in interface java.util.Map<java.lang.String,​java.lang.Object>

      • putAll

        public void putAll​(java.util.Map<? extends java.lang.String,​?> t)
        Specified by:
        putAll in interface java.util.Map<java.lang.String,​java.lang.Object>

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map<java.lang.String,​java.lang.Object>

      • keySet

        public java.util.Set<java.lang.String> keySet()
        Specified by:
        keySet in interface java.util.Map<java.lang.String,​java.lang.Object>

      • values

        public java.util.Collection<java.lang.Object> values()
        Specified by:
        values in interface java.util.Map<java.lang.String,​java.lang.Object>

      • entrySet

        public java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.Object>> entrySet()
        Specified by:
        entrySet in interface java.util.Map<java.lang.String,​java.lang.Object>

      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Map<java.lang.String,​java.lang.Object>
        Overrides:
        hashCode in class java.lang.Object