org.mule.runtime.api.el

Interface ExpressionLanguage

All Known Subinterfaces:

MuleExpressionLanguage

public interface ExpressionLanguage

Evaluates an expression considering a set of given bindings and a set of global ones.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	addGlobalBindings(BindingContext bindingContext) Includes the bindings in a given BindingContext as global ones, that should not change often and should be considered for all subsequent operations.
default CompiledExpression	compile(String expression, BindingContext context) Compiles a specified expression with a given binding context and returns the CompiledExpression`
default CompiledExpression	compile(String nameIdentifier, String expression, BindingContext context) Compiles a specified expression with a given binding context and a name.
TypedValue<?>	evaluate(String expression, BindingContext context) Evaluates an expression according to a given BindingContext and the global one.
TypedValue<?>	evaluate(String expression, DataType expectedOutputType, BindingContext context) Evaluates an expression according to a given BindingContext, the global one and the DataType of the expected result.
TypedValue<?>	evaluateLogExpression(String expression, BindingContext context) Evaluates an expression according to a given BindingContext and the global one.
default ExpressionLanguageSession	openSession(BindingContext context) Returns an object that caches computation results.
Iterator<TypedValue<?>>	split(String expression, BindingContext context) Splits using the specified expression.
ValidationResult	validate(String expression) Verifies whether an expression is valid or not syntactically.

Method Detail

addGlobalBindings

void addGlobalBindings(BindingContext bindingContext)

Includes the bindings in a given BindingContext as global ones, that should not change often and should be considered for all subsequent operations.

Parameters:

bindingContext - the context containing the bindings to add

evaluate

TypedValue<?> evaluate(String expression,
                       BindingContext context)
                throws ExpressionExecutionException

Evaluates an expression according to a given BindingContext and the global one.

Parameters:

expression - the EL expression

context - the current dynamic binding context to consider

Returns:

the result of the expression plus its type

Throws:

ExpressionExecutionException - when an error occurs during evaluation

evaluate

TypedValue<?> evaluate(String expression,
                       DataType expectedOutputType,
                       BindingContext context)
                throws ExpressionExecutionException

Evaluates an expression according to a given BindingContext, the global one and the DataType of the expected result.

Parameters:

expression - the EL expression

expectedOutputType - the expected output type so that automatic conversion can be performed for the resulting value type.

context - the current dynamic binding context to consider

Returns:

the result of the expression plus its type

Throws:

ExpressionExecutionException - when an error occurs during evaluation or while parsing

evaluateLogExpression

TypedValue<?> evaluateLogExpression(String expression,
                                    BindingContext context)
                             throws ExpressionExecutionException

Evaluates an expression according to a given BindingContext and the global one. The evaluation of this script will do a best effort to avoid failing when the result value can not be represented in the corresponding format.

Parameters:

expression - the EL expression

context - the current dynamic binding context to consider

Returns:

the result of the expression plus its type

Throws:

ExpressionExecutionException - when an error occurs during evaluation

validate

ValidationResult validate(String expression)

Verifies whether an expression is valid or not syntactically.

Parameters:

expression - to be validated

Returns:

a ValidationResult indicating whether the validation was successful or not

split

Iterator<TypedValue<?>> split(String expression,
                              BindingContext context)

Splits using the specified expression. The expression should return a collection of elements or an object. In case of the object it will iterate through the entries

Parameters:

expression - the expression to be used to split

context - the current dynamic binding context to consider

Returns:

an iterator with the elements that were split

compile

default CompiledExpression compile(String expression,
                                   BindingContext context)
                            throws ExpressionCompilationException

Compiles a specified expression with a given binding context and returns the CompiledExpression`

Parameters:

expression - The expression

context - The context to compile against

Returns:

The compiled expression

Throws:

ExpressionCompilationException - when an error occurs during compilation

Since:

1.3

compile

default CompiledExpression compile(String nameIdentifier,
                                   String expression,
                                   BindingContext context)
                            throws ExpressionCompilationException

Compiles a specified expression with a given binding context and a name. It returns the compiled expression

Parameters:

expression - The expression

context - The context to compile against

nameIdentifier - The nameIdentifier to be given to the compiled expression

Returns:

The compiled expression

Throws:

ExpressionCompilationException - when an error occurs during compilation

Since:

1.4

openSession

default ExpressionLanguageSession openSession(BindingContext context)

Returns an object that caches computation results. Provides better performance when evaluation multiple expressions on the same bindings.

Sessions obtained through this method have to be explicitly closed.

Parameters:

context - the current dynamic binding context to consider

Returns:

a session associated to the provided context

Since:

1.2