org.mule.runtime.core.api.el

Interface ExpressionManager

All Superinterfaces:

org.mule.runtime.api.el.ExpressionLanguage, org.mule.runtime.api.el.MuleExpressionLanguage

All Known Subinterfaces:

ExtendedExpressionManager

All Known Implementing Classes:

DefaultExpressionManager

public interface ExpressionManager
extends org.mule.runtime.api.el.MuleExpressionLanguage

Provides universal access for evaluating expressions embedded in Mule configurations, such as XML, Java, scripting and annotations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EXPRESSION_POSTFIX
static String	DEFAULT_EXPRESSION_PREFIX

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType expectedOutputType) Evaluates an expression according to the global BindingContext and the DataType of the expected result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType expectedOutputType, org.mule.runtime.api.el.BindingContext context, Event event) Evaluates an expression according to a given BindingContext, the global one, the DataType of the expected result and an Event.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, org.mule.runtime.api.metadata.DataType expectedOutputType, org.mule.runtime.api.el.BindingContext context, Event event, FlowConstruct flowConstruct, boolean failOnNull) Evaluates an expression according to a given BindingContext, the global one, the DataType of the expected result and an Event.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, org.mule.runtime.api.el.BindingContext context) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, FlowConstruct flowConstruct) Execute the expression returning the result.
org.mule.runtime.api.metadata.TypedValue	evaluate(String expression, Event event, FlowConstruct flowConstruct, org.mule.runtime.api.el.BindingContext context) Execute the expression returning the result.
boolean	evaluateBoolean(String expression, Event event, FlowConstruct flowConstruct) Evaluates an expression considering a boolean as output.
boolean	evaluateBoolean(String expression, Event event, FlowConstruct flowConstruct, boolean nullReturnsTrue, boolean nonBooleanReturnsTrue) Evaluates an expression considering a boolean as output.
Iterator<org.mule.runtime.api.metadata.TypedValue<?>>	split(String expression, Event event, org.mule.runtime.api.el.BindingContext bindingContext) Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.
Iterator<org.mule.runtime.api.metadata.TypedValue<?>>	split(String expression, Event event, FlowConstruct flowConstruct, org.mule.runtime.api.el.BindingContext bindingContext) Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.

Methods inherited from interface org.mule.runtime.api.el.MuleExpressionLanguage

isExpression, isValid

Methods inherited from interface org.mule.runtime.api.el.ExpressionLanguage

addGlobalBindings, evaluate, evaluate, split, validate

Field Detail

DEFAULT_EXPRESSION_PREFIX

static final String DEFAULT_EXPRESSION_PREFIX

See Also:

Constant Field Values

DEFAULT_EXPRESSION_POSTFIX

static final String DEFAULT_EXPRESSION_POSTFIX

See Also:

Constant Field Values

Method Detail

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression)
                                           throws ExpressionRuntimeException

Execute the expression returning the result. The expression will be executed by the expression language implementation without making any event or message context available.

Parameters:

expression - the expression to be executed

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                  Event event)
                                           throws ExpressionRuntimeException

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Parameters:

expression - the expression to be executed

event - the current event being processed

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                  Event event,
                                                  FlowConstruct flowConstruct)
                                           throws ExpressionRuntimeException

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Parameters:

expression - the expression to be executed

event - the current event being processed

flowConstruct - the flow where the event is being processed

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                  Event event,
                                                  org.mule.runtime.api.el.BindingContext context)
                                           throws ExpressionRuntimeException

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Parameters:

expression - the expression to be executed

event - the current event being processed

context - the bindings to be considered

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                  Event event,
                                                  FlowConstruct flowConstruct,
                                                  org.mule.runtime.api.el.BindingContext context)
                                           throws ExpressionRuntimeException

Execute the expression returning the result. The expression will be executed with MuleEvent context, meaning the expression language implementation should provided access to the message. A Map of variables can be provided that will be able to the expression when executed. Variable provided in the map will only be available if there are no conflict with context variables provided by the expression language implementation.

This version of evaluate performs expression evaulation on an immutable event. Any Event or InternalMessage mutation performed within the expression will impact within the context of expression evaluation but will not mutated the event parameter.

Parameters:

expression - the expression to be executed

event - the current event being processed

flowConstruct - the flow where the event is being processed

context - the bindings to be considered

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                  org.mule.runtime.api.metadata.DataType expectedOutputType)
                                           throws ExpressionRuntimeException

Evaluates an expression according to the global BindingContext 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.

Returns:

the result of the expression plus its type

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression or during transformation

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                  org.mule.runtime.api.metadata.DataType expectedOutputType,
                                                  org.mule.runtime.api.el.BindingContext context,
                                                  Event event)
                                           throws ExpressionRuntimeException

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

Parameters:

expression - the EL expression

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

context - an expression binding context to consider

event - the current event to consider

Returns:

the result of the expression plus its type

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression or during transformation

evaluate

org.mule.runtime.api.metadata.TypedValue evaluate(String expression,
                                                  org.mule.runtime.api.metadata.DataType expectedOutputType,
                                                  org.mule.runtime.api.el.BindingContext context,
                                                  Event event,
                                                  FlowConstruct flowConstruct,
                                                  boolean failOnNull)
                                           throws ExpressionRuntimeException

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

Parameters:

expression - the EL expression

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

context - an expression binding context to consider

event - the current event to consider

flowConstruct - the flow where the event is being processed

failOnNull - indicates if should fail if the evaluation result is null

Returns:

the result of the expression plus its type

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression or during transformation

evaluateBoolean

boolean evaluateBoolean(String expression,
                        Event event,
                        FlowConstruct flowConstruct)
                 throws ExpressionRuntimeException

Evaluates an expression considering a boolean as output. If the result cannot be clearly transformed or is null, false will be returned.

Parameters:

expression - a single expression to be evaluated and transformed

event - the Event to consider

flowConstruct - the FlowConstruct to consider

Returns:

true if the expression evaluated to that or "true", false otherwise

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

evaluateBoolean

boolean evaluateBoolean(String expression,
                        Event event,
                        FlowConstruct flowConstruct,
                        boolean nullReturnsTrue,
                        boolean nonBooleanReturnsTrue)
                 throws ExpressionRuntimeException

Evaluates an expression considering a boolean as output.

Parameters:

expression - a single expression to be evaluated and transformed

event - the Event to consider

flowConstruct - the FlowConstruct to consider

nullReturnsTrue - whether or not a null outcome should be considered a true

nonBooleanReturnsTrue - whether or not a non boolean outcome should be considered a true

Returns:

true if the expression evaluated to that, "true" or the above flags where considered, false otherwise

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

split

Iterator<org.mule.runtime.api.metadata.TypedValue<?>> split(String expression,
                                                            Event event,
                                                            FlowConstruct flowConstruct,
                                                            org.mule.runtime.api.el.BindingContext bindingContext)
                                                     throws ExpressionRuntimeException

Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.

Parameters:

expression - the expression to be executed

event - the current event being processed

flowConstruct - the flow where the event is being processed

bindingContext - the bindings to consider

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression

split

Iterator<org.mule.runtime.api.metadata.TypedValue<?>> split(String expression,
                                                            Event event,
                                                            org.mule.runtime.api.el.BindingContext bindingContext)
                                                     throws ExpressionRuntimeException

Evaluates an expression according to a given BindingContext, an Event and a FlowConstruct.

Parameters:

expression - the expression to be executed

event - the current event being processed

bindingContext - the bindings to consider

Returns:

the result of execution of the expression.

Throws:

ExpressionRuntimeException - if a problem occurs evaluating the expression