Package net.objecthunter.exp4j

Class ExpressionBuilder

java.lang.Object

net.objecthunter.exp4j.ExpressionBuilder

public class ExpressionBuilder
extends Object

Factory class for Expression instances. This class is the main API entrypoint. Users should create new Expression instances using this factory class.

Constructor Summary

Constructors

Constructor	Description
ExpressionBuilder(String expression)	Create a new ExpressionBuilder instance and initialize it with a given expression string.

Method Summary

Modifier and Type	Method	Description
Expression	build()	Build the Expression instance using the custom operators and functions set.
ExpressionBuilder	function(Function function)	Add a Function implementation available for use in the expression
ExpressionBuilder	functions(List<Function> functions)	Add multiple Function implementations available for use in the expression
ExpressionBuilder	functions(Function... functions)	Add multiple Function implementations available for use in the expression
ExpressionBuilder	implicitMultiplication(boolean enabled)
ExpressionBuilder	operator(List<Operator> operators)	Add multiple Operator implementations which should be available for use in the expression
ExpressionBuilder	operator(Operator operator)	Add an Operator which should be available for use in the expression
ExpressionBuilder	operator(Operator... operators)	Add multiple Operator implementations which should be available for use in the expression
ExpressionBuilder	variable(String variableName)	Declare a variable used in the expression
ExpressionBuilder	variables(String... variableNames)	Declare variable names used in the expression
ExpressionBuilder	variables(Set<String> variableNames)	Declare variable names used in the expression

Methods inherited from class java.lang.Object

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

Constructor Details

ExpressionBuilder

public ExpressionBuilder(String expression)

Create a new ExpressionBuilder instance and initialize it with a given expression string.

Parameters:

expression - the expression to be parsed

Method Details

function

public ExpressionBuilder function(Function function)

Add a Function implementation available for use in the expression

Parameters:

function - the custom Function implementation that should be available for use in the expression.

Returns:

the ExpressionBuilder instance

functions

public ExpressionBuilder functions(Function... functions)

Add multiple Function implementations available for use in the expression

Parameters:

functions - the custom Function implementations

Returns:

the ExpressionBuilder instance

functions

public ExpressionBuilder functions(List<Function> functions)

Add multiple Function implementations available for use in the expression

Parameters:

functions - A List of custom Function implementations

Returns:

the ExpressionBuilder instance

variables

public ExpressionBuilder variables(Set<String> variableNames)

Declare variable names used in the expression

Parameters:

variableNames - the variables used in the expression

Returns:

the ExpressionBuilder instance

variables

public ExpressionBuilder variables(String... variableNames)

Declare variable names used in the expression

Parameters:

variableNames - the variables used in the expression

Returns:

the ExpressionBuilder instance

variable

public ExpressionBuilder variable(String variableName)

Declare a variable used in the expression

Parameters:

variableName - the variable used in the expression

Returns:

the ExpressionBuilder instance

implicitMultiplication

public ExpressionBuilder implicitMultiplication(boolean enabled)

operator

public ExpressionBuilder operator(Operator operator)

Add an Operator which should be available for use in the expression

Parameters:

operator - the custom Operator to add

Returns:

the ExpressionBuilder instance

operator

public ExpressionBuilder operator(Operator... operators)

Add multiple Operator implementations which should be available for use in the expression

Parameters:

operators - the set of custom Operator implementations to add

Returns:

the ExpressionBuilder instance

operator

public ExpressionBuilder operator(List<Operator> operators)

Add multiple Operator implementations which should be available for use in the expression

Parameters:

operators - the List of custom Operator implementations to add

Returns:

the ExpressionBuilder instance

build

public Expression build()

Build the Expression instance using the custom operators and functions set.

Returns:

an Expression instance which can be used to evaluate the result of the expression