org.flowable.common.engine.impl.el.function

Class AbstractFlowableVariableExpressionFunction

java.lang.Object

org.flowable.common.engine.impl.el.function.AbstractFlowableVariableExpressionFunction

All Implemented Interfaces:

FlowableFunctionDelegate, FlowableAstFunctionCreator

Direct Known Subclasses:

AbstractVariableComparatorExpressionFunction, VariableBase64ExpressionFunction, VariableContainsAnyExpressionFunction, VariableContainsExpressionFunction, VariableEqualsExpressionFunction, VariableExistsExpressionFunction, VariableGetExpressionFunction, VariableGetOrDefaultExpressionFunction, VariableIsEmptyExpressionFunction, VariableIsNotEmptyExpressionFunction, VariableNotEqualsExpressionFunction

public abstract class AbstractFlowableVariableExpressionFunction
extends Object
implements FlowableAstFunctionCreator, FlowableFunctionDelegate

Author:

Joram Barrez, Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field and Description
protected String	functionName
protected Collection<String>	functionNamesOptions
protected Method	method
protected String	variableScopeName

Constructor Summary

Constructors

Constructor and Description
AbstractFlowableVariableExpressionFunction(List<String> functionNameOptions, String functionName)
AbstractFlowableVariableExpressionFunction(String functionName)

Method Summary

Modifier and Type	Method and Description
AstFunction	createFunction(String name, int index, AstParameters parameters, boolean varargs, FlowableExpressionParser parser) Create an AstFunction based on the provided name, index, parameters.
protected AstNode	createVariableNameNode(AstNode variableNode)
protected Method	findMethod(String functionName)
Method	functionMethod() Returns the method that is invoked by JUEL.
Collection<String>	getFunctionNames() The names of the functions that this creator can create.
protected static Object	getVariableValue(VariableContainer variableContainer, String variableName)
String	localName() The name of the method when used in an expression, like the second part of ${prefix:method()}.
Collection<String>	localNames() All the names of the method when used in an expression, like the second part of ${prefix:method()}.
String	prefix() The prefix of the method when used in an expression, like the first part of ${prefix:method()}.
Collection<String>	prefixes() All the prefixes of the method when used in an expression.
protected static boolean	valuesAreNumbers(Object variableValue, Object actualValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

method

protected Method method

functionName

protected String functionName

functionNamesOptions

protected Collection<String> functionNamesOptions

variableScopeName

protected String variableScopeName

Constructor Detail

AbstractFlowableVariableExpressionFunction

public AbstractFlowableVariableExpressionFunction(String functionName)

AbstractFlowableVariableExpressionFunction

public AbstractFlowableVariableExpressionFunction(List<String> functionNameOptions,
                                                  String functionName)

Method Detail

findMethod

protected Method findMethod(String functionName)

prefix

public String prefix()

Description copied from interface: FlowableFunctionDelegate

The prefix of the method when used in an expression, like the first part of ${prefix:method()}. Will be used to match the text of the expression to the actual FlowableFunctionDelegate instance.

Specified by:

prefix in interface FlowableFunctionDelegate

prefixes

public Collection<String> prefixes()

Description copied from interface: FlowableFunctionDelegate

All the prefixes of the method when used in an expression. It allows one method to cover multiple prefixes. e.g. ${prefix:method()} or {$code ${alternativePrefix:method()}}. Will be used to match the text of the expression to the actual FlowableFunctionDelegate instance.

Specified by:

prefixes in interface FlowableFunctionDelegate

localName

public String localName()

Description copied from interface: FlowableFunctionDelegate

The name of the method when used in an expression, like the second part of ${prefix:method()}. Will be used to match the text of the expression to the actual FlowableFunctionDelegate instance.

Specified by:

localName in interface FlowableFunctionDelegate

localNames

public Collection<String> localNames()

Description copied from interface: FlowableFunctionDelegate

All the names of the method when used in an expression, like the second part of ${prefix:method()}. It allows one method to cover multiple local names. e.g. ${prefix:method()} or ${prefix:alternativeMethod()}. Will be used to match the text of the expression to the actual FlowableFunctionDelegate instance.

Specified by:

localNames in interface FlowableFunctionDelegate

functionMethod

public Method functionMethod()

Description copied from interface: FlowableFunctionDelegate

Returns the method that is invoked by JUEL.

Specified by:

functionMethod in interface FlowableFunctionDelegate

getVariableValue

protected static Object getVariableValue(VariableContainer variableContainer,
                                         String variableName)

valuesAreNumbers

protected static boolean valuesAreNumbers(Object variableValue,
                                          Object actualValue)

getFunctionNames

public Collection<String> getFunctionNames()

Description copied from interface: FlowableAstFunctionCreator

The names of the functions that this creator can create.

Specified by:

getFunctionNames in interface FlowableAstFunctionCreator

createFunction

public AstFunction createFunction(String name,
                                  int index,
                                  AstParameters parameters,
                                  boolean varargs,
                                  FlowableExpressionParser parser)

Description copied from interface: FlowableAstFunctionCreator

Create an AstFunction based on the provided name, index, parameters. Potentially creating new parameters to enhance the function.

Specified by:

createFunction in interface FlowableAstFunctionCreator

Parameters:

name - the name of the function

index - the index

parameters - the parameters for the function

varargs - whether varargs is supported

parser - the parser for potentially creating identifiers

createVariableNameNode

protected AstNode createVariableNameNode(AstNode variableNode)