Class ExpressionProcessor
java.lang.Object
io.camunda.zeebe.engine.processing.common.ExpressionProcessor
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
static interface
-
Constructor Summary
ConstructorDescriptionExpressionProcessor
(io.camunda.zeebe.el.ExpressionLanguage expressionLanguage, ExpressionProcessor.VariablesLookup lookup) -
Method Summary
Modifier and TypeMethodDescriptionevaluateAnyExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result no matter the type.evaluateArrayExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as a list.evaluateArrayOfStringsExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as a list of strings.evaluateBooleanExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as boolean.evaluateDateTimeExpression
(io.camunda.zeebe.el.Expression expression, Long scopeKey) Evaluates the given expression and returns the result as ZonedDateTime.evaluateIntervalExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as an Interval.evaluateLongExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as long.evaluateMessageCorrelationKeyExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as String.evaluateStringExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as string.evaluateStringExpressionAsDirectBuffer
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as string wrapped inDirectBuffer
.evaluateVariableMappingExpression
(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression of a variable mapping and returns the result as buffer.
-
Constructor Details
-
ExpressionProcessor
public ExpressionProcessor(io.camunda.zeebe.el.ExpressionLanguage expressionLanguage, ExpressionProcessor.VariablesLookup lookup)
-
-
Method Details
-
evaluateStringExpression
public Either<Failure,String> evaluateStringExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as string. If the evaluation fails or the result is not a string then a failure is returned.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as string, or a failure
-
evaluateStringExpressionAsDirectBuffer
public Either<Failure,org.agrona.DirectBuffer> evaluateStringExpressionAsDirectBuffer(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as string wrapped inDirectBuffer
. If the evaluation fails or the result is not a string then a failure is returned.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as buffer, or a failure
-
evaluateLongExpression
public Either<Failure,Long> evaluateLongExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as long. If the evaluation fails or the result is not a number then a failure is returned.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as long, or a failure
-
evaluateBooleanExpression
public Either<Failure,Boolean> evaluateBooleanExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as boolean. If the evaluation fails or the result is not a boolean then a failure is returned.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as boolean, or a failure
-
evaluateIntervalExpression
public Either<Failure,Interval> evaluateIntervalExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as an Interval. If the evaluation fails or the result is not an interval then a failure is returned.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as interval or a failure
-
evaluateDateTimeExpression
public Either<Failure,ZonedDateTime> evaluateDateTimeExpression(io.camunda.zeebe.el.Expression expression, Long scopeKey) Evaluates the given expression and returns the result as ZonedDateTime. If the evaluation fails or the result is not a ZonedDateTime then a failure is returned.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as ZonedDateTime or a failure
- Throws:
ExpressionProcessor.EvaluationException
- if expression evaluation failed
-
evaluateAnyExpression
public Either<Failure,org.agrona.DirectBuffer> evaluateAnyExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result no matter the type.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as buffer, or a failure if the evaluation fails
-
evaluateArrayExpression
public Either<Failure,List<org.agrona.DirectBuffer>> evaluateArrayExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as a list. The entries of the list are encoded in MessagePack and can have any type.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as a list, or a failure if the evaluation fails
-
evaluateArrayOfStringsExpression
public Either<Failure,List<String>> evaluateArrayOfStringsExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as a list of strings.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as a list of regular strings, or a failure if the evaluation fails
-
evaluateMessageCorrelationKeyExpression
public Either<Failure,String> evaluateMessageCorrelationKeyExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression and returns the result as String. If the evaluation result is a number it is automatically converted to a string.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as String, or a failure if the evaluation fails
-
evaluateVariableMappingExpression
public Either<Failure,org.agrona.DirectBuffer> evaluateVariableMappingExpression(io.camunda.zeebe.el.Expression expression, long scopeKey) Evaluates the given expression of a variable mapping and returns the result as buffer. If the evaluation fails or the result is not a context then a failure is returned.- Parameters:
expression
- the expression to evaluatescopeKey
- the scope to load the variables from (a negative key is intended to imply an empty variable context)- Returns:
- either the evaluation result as buffer, or a failure
-