Class EvaluationContext
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ELContext
private final FunctionMapper
private final VariableMapper
-
Constructor Summary
ConstructorsConstructorDescriptionEvaluationContext
(ELContext elContext, FunctionMapper fnMapper, VariableMapper varMapper) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEvaluationListener
(EvaluationListener listener) Registers an evaluation listener to the ELContext.convertToType
(Object obj, Class<?> targetType) Converts an object to a specific type.void
enterLambdaScope
(Map<String, Object> args) Installs a Lambda argument map, in preparation for the evaluation of a Lambda expression.void
Exits the Lambda expression evaluation.getContext
(Class key) Returns the context object associated with the given key.Retrieves theELResolver
associated with this context.Returns the list of registered evaluation listeners.Retrieves theFunctionMapper
associated with thisELContext
.Retrieves theImportHandler
associated with thisELContext
.getLambdaArgument
(String arg) Retrieves the Lambda argument associated with a formal parameter.Retrieves theVariableMapper
associated with thisELContext
.boolean
isLambdaArgument
(String arg) Inquires if the name is a LambdaArgumentboolean
Returns whether anELResolver
has successfully resolved a given (base, property) pair.void
notifyAfterEvaluation
(String expr) Notifies the listeners after an Jakarta Expression Language expression is evaluatedvoid
notifyBeforeEvaluation
(String expr) Notifies the listeners before an Jakarta Expression Language expression is evaluatedvoid
notifyPropertyResolved
(Object base, Object property) Notifies the listeners when the (base, property) pair is resolvedvoid
putContext
(Class key, Object contextObject) Associates a context object with thisELContext
.void
setPropertyResolved
(boolean resolved) Called to indicate that aELResolver
has successfully resolved a given (base, property) pair.void
setPropertyResolved
(Object base, Object property) Called to indicate that aELResolver
has successfully resolved a given (base, property) pair and to notify theEvaluationListener
s.
-
Field Details
-
elContext
-
fnMapper
-
varMapper
-
-
Constructor Details
-
EvaluationContext
-
-
Method Details
-
getELContext
-
getFunctionMapper
Description copied from class:ELContext
Retrieves theFunctionMapper
associated with thisELContext
.- Specified by:
getFunctionMapper
in classELContext
- Returns:
- The function mapper to be consulted for the resolution of Jakarta Expression Language functions.
-
getVariableMapper
Description copied from class:ELContext
Retrieves theVariableMapper
associated with thisELContext
.- Specified by:
getVariableMapper
in classELContext
- Returns:
- The variable mapper to be consulted for the resolution of Jakarta Expression Language variables.
-
getContext
Description copied from class:ELContext
Returns the context object associated with the given key.The
ELContext
maintains a collection of context objects relevant to the evaluation of an expression. These context objects are used byELResolver
s. This method is used to retrieve the context with the given key from the collection.By convention, the object returned will be of the type specified by the
key
. However, this is not required and the key is used strictly as a unique identifier.- Overrides:
getContext
in classELContext
- Parameters:
key
- The unique identifier that was used to associate the context object with thisELContext
.- Returns:
- The context object associated with the given key, or null if no such context was found.
-
getELResolver
Description copied from class:ELContext
Retrieves theELResolver
associated with this context.The
ELContext
maintains a reference to theELResolver
that will be consulted to resolve variables and properties during an expression evaluation. This method retrieves the reference to the resolver.Once an
ELContext
is constructed, the reference to theELResolver
associated with the context cannot be changed.- Specified by:
getELResolver
in classELContext
- Returns:
- The resolver to be consulted for variable and property resolution during expression evaluation.
-
isPropertyResolved
public boolean isPropertyResolved()Description copied from class:ELContext
Returns whether anELResolver
has successfully resolved a given (base, property) pair.The
CompositeELResolver
checks this property to determine whether it should consider or skip other component resolvers.- Overrides:
isPropertyResolved
in classELContext
- Returns:
- true if the property has been resolved, or false if not.
- See Also:
-
putContext
Description copied from class:ELContext
Associates a context object with thisELContext
.The
ELContext
maintains a collection of context objects relevant to the evaluation of an expression. These context objects are used byELResolver
s. This method is used to add a context object to that collection.By convention, the
contextObject
will be of the type specified by thekey
. However, this is not required and the key is used strictly as a unique identifier.- Overrides:
putContext
in classELContext
- Parameters:
key
- The key used by an @{link ELResolver} to identify this context object.contextObject
- The context object to add to the collection.
-
setPropertyResolved
public void setPropertyResolved(boolean resolved) Description copied from class:ELContext
Called to indicate that aELResolver
has successfully resolved a given (base, property) pair. UseELContext.setPropertyResolved(Object, Object)
if resolved is true and to notifyEvaluationListener
s.The
CompositeELResolver
checks this property to determine whether it should consider or skip other component resolvers.- Overrides:
setPropertyResolved
in classELContext
- Parameters:
resolved
- true if the property has been resolved, or false if not.- See Also:
-
setPropertyResolved
Description copied from class:ELContext
Called to indicate that aELResolver
has successfully resolved a given (base, property) pair and to notify theEvaluationListener
s.The
CompositeELResolver
checks this property to determine whether it should consider or skip other component resolvers.- Overrides:
setPropertyResolved
in classELContext
- Parameters:
base
- The base objectproperty
- The property object- See Also:
-
addEvaluationListener
Description copied from class:ELContext
Registers an evaluation listener to the ELContext.- Overrides:
addEvaluationListener
in classELContext
- Parameters:
listener
- The listener to be added.
-
getEvaluationListeners
Description copied from class:ELContext
Returns the list of registered evaluation listeners.- Overrides:
getEvaluationListeners
in classELContext
- Returns:
- The list of registered evaluation listeners.
-
notifyBeforeEvaluation
Description copied from class:ELContext
Notifies the listeners before an Jakarta Expression Language expression is evaluated- Overrides:
notifyBeforeEvaluation
in classELContext
- Parameters:
expr
- The Jakarta Expression Language expression string to be evaluated
-
notifyAfterEvaluation
Description copied from class:ELContext
Notifies the listeners after an Jakarta Expression Language expression is evaluated- Overrides:
notifyAfterEvaluation
in classELContext
- Parameters:
expr
- The Jakarta Expression Language expression string that has been evaluated
-
notifyPropertyResolved
Description copied from class:ELContext
Notifies the listeners when the (base, property) pair is resolved- Overrides:
notifyPropertyResolved
in classELContext
- Parameters:
base
- The base objectproperty
- The property Object
-
isLambdaArgument
Description copied from class:ELContext
Inquires if the name is a LambdaArgument- Overrides:
isLambdaArgument
in classELContext
- Parameters:
arg
- A possible Lambda formal parameter name- Returns:
- true if arg is a LambdaArgument, false otherwise.
-
getLambdaArgument
Description copied from class:ELContext
Retrieves the Lambda argument associated with a formal parameter. If the Lambda expression is nested within other Lambda expressions, the arguments for the current Lambda expression is first searched, and if not found, the arguments for the immediate nesting Lambda expression then searched, and so on.- Overrides:
getLambdaArgument
in classELContext
- Parameters:
arg
- The formal parameter for the Lambda argument- Returns:
- The object associated with formal parameter. Null if no object has been associated with the parameter.
-
enterLambdaScope
Description copied from class:ELContext
Installs a Lambda argument map, in preparation for the evaluation of a Lambda expression. The arguments in the map will be in scope during the evaluation of the Lambda expression.- Overrides:
enterLambdaScope
in classELContext
- Parameters:
args
- The Lambda arguments map
-
exitLambdaScope
public void exitLambdaScope()Description copied from class:ELContext
Exits the Lambda expression evaluation. The Lambda argument map that was previously installed is removed.- Overrides:
exitLambdaScope
in classELContext
-
convertToType
Description copied from class:ELContext
Converts an object to a specific type. If a custom converter in theELResolver
handles this conversion, it is used. Otherwise the standard coercions is applied.An
ELException
is thrown if an error occurs during the conversion.- Overrides:
convertToType
in classELContext
- Parameters:
obj
- The object to convert.targetType
- The target type for the conversion.- Returns:
- object converted to
targetType
-
getImportHandler
Description copied from class:ELContext
Retrieves theImportHandler
associated with thisELContext
.- Overrides:
getImportHandler
in classELContext
- Returns:
- The import handler to manage imports of classes and packages.
-