Package ch.andre601.expressionparser

Class ExpressionParserEngine.Builder<T extends ExpressionParserEngine>

java.lang.Object

ch.andre601.expressionparser.ExpressionParserEngine.Builder<T>

Type Parameters:

T - Object implementing the ExpressionParserEngine interface.

Direct Known Subclasses:

DefaultExpressionParserEngine.DefaultBuilder

Enclosing interface:

ExpressionParserEngine

public abstract static class ExpressionParserEngine.Builder<T extends ExpressionParserEngine>
extends Object

Abstract class that can be used to create a new Builder for a ExpressionParserEngine.
The class offers a addDefaults() method to populate the Lists and Map with default values (TokenReaders, Operators and ValueReaders).

Constructor Summary

Constructors

Constructor	Description
Builder()	Constructor for creating a new Builder.

Method Summary

Modifier and Type	Method	Description
ExpressionParserEngine.Builder<T>	addDefaults()	Applies default values for this Builder class to use.
ExpressionParserEngine.Builder<T>	addOperator(Token token, Operator operator)	Adds a new Token instance as key with a new Operator instance as value to use by the DefaultExpressionParserEngine.
ExpressionParserEngine.Builder<T>	addTokenReader(TokenReader tokenReader)	Adds a new TokenReader instance to use by the DefaultExpressionParserEngine.
ExpressionParserEngine.Builder<T>	addValueReader(ValueReader valueReader)	Adds a new ValueReader instance to use by the DefaultExpressionParserEngine.
abstract T	build()	Method to build a new instance of what this Builder is using.
ExpressionParserEngine.Builder<T>	createDefault()	Deprecated. Method renamed for clarity.
Map<Token,Operator>	getOperators()	Returns a Map of currently set Tokens and Operators.
List<TokenReader>	getTokenReaders()	Returns a List of currently set TokenReaders.
List<ValueReader>	getValueReaders()	Returns a List of currently set ValueReaders.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Constructor for creating a new Builder.

Method Details

createDefault

@Deprecated
public ExpressionParserEngine.Builder<T> createDefault()

Deprecated.

Method renamed for clarity. Use addDefaults() instead.

Applies default values for this Builder class to use. Namely:

• TokenReader instances:
  • PatternTokenReader with BooleanToken.TRUE for pattern true
  • PatternTokenReader with BooleanToken.FALSE for pattern false
  • PatternTokenReader with DefaultTokens.AND for patterns and and &&
  • PatternTokenReader with DefaultTokens.OR for patterns or and ||
  • PatternTokenReader with DefaultTokens.EQUAL for patterns = and ==
  • PatternTokenReader with DefaultTokens.EQUAL_IGNORE_CASE for patterns ~ and =~
  • PatternTokenReader with DefaultTokens.NOT_EQUAL for pattern !=
  • PatternTokenReader with DefaultTokens.NOT_EQUAL_IGNORE_CASE for pattern !~
  • PatternTokenReader with DefaultTokens.STARTS_WITH for pattern |-
  • PatternTokenReader with DefaultTokens.ENDS_WITH for pattern -|
  • PatternTokenReader with DefaultTokens.CONTAINS for pattern <_
  • PatternTokenReader with DefaultTokens.GREATER_THAN for pattern >
  • PatternTokenReader with DefaultTokens.GREATER_OR_EQUAL_THAN for pattern >=
  • PatternTokenReader with DefaultTokens.LESS_THAN for pattern <
  • PatternTokenReader with DefaultTokens.LESS_OR_EQUAL_THAN for pattern <=
  • PatternTokenReader with DefaultTokens.OPENING_PARENTHESIS for pattern (
  • PatternTokenReader with DefaultTokens.CLOSING_PARENTHESIS for pattern )
  • PatternTokenReader with DefaultTokens.NEGATION for pattern !
  • PatternTokenReader with DefaultTokens.CONCAT_STRING for pattern .
  • PatternTokenReader with DefaultTokens.ADD for pattern +
  • PatternTokenReader with DefaultTokens.SUBTRACT for pattern -
  • PatternTokenReader with DefaultTokens.MULTIPLY for pattern *
  • PatternTokenReader with DefaultTokens.DIVIDE for pattern /
  • QuotedLiteralTokenReader with chars " and ', and priority -10
  • NumberTokenReader with priority -50
  • NonQuotedLiteralTokenReader with priority -100
• Operators:
  • ListOperator with priority 100 and ExpressionTemplates.and(Collection) for DefaultTokens.AND
  • ListOperator with priority 50 and ExpressionTemplates.or(Collection) for DefaultTokens.OR
  • Operator with priority 25 and ExpressionTemplates.equal(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.EQUAL
  • Operator with priority 25 and ExpressionTemplates.equalIgnoreCase(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.EQUAL_IGNORE_CASE
  • Operator with priority 25 and ExpressionTemplates.notEqual(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.NOT_EQUAL
  • Operator with priority 25 and ExpressionTemplates.notEqualIgnoreCase(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.NOT_EQUAL_IGNORE_CASE
  • Operator with priority 25 and ExpressionTemplates.startsWith(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.STARTS_WITH
  • Operator with priority 25 and ExpressionTemplates.endsWith(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.ENDS_WITH
  • Operator with priority 25 and ExpressionTemplates.contains(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.CONTAINS
  • Operator with priority 25 and ExpressionTemplates.greater(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.GREATER_THAN
  • Operator with priority 25 and ExpressionTemplates.greaterOrEqual(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.GREATER_OR_EQUAL_THAN
  • Operator with priority 25 and ExpressionTemplates.less(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.LESS_THAN
  • Operator with priority 25 and ExpressionTemplates.lessOrEqual(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.LESS_OR_EQUAL_THAN
  • ListOperator with priority 10 and ExpressionTemplates.concat(Collection) for DefaultTokens.CONCAT_STRING
  • ListOperator with priority 4 and ExpressionTemplates.sum(Collection) for DefaultTokens.ADD
  • Operator with priority 3 and ExpressionTemplates.sub(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.SUBTRACT
  • ListOperator with priority 2 and ExpressionTemplates.product(Collection) for DefaultTokens.MULTIPLY
  • Operator with priority 1 and ExpressionTemplates.div(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.DIVIDE
• ValueReaders:
  • BooleanConstantReader
  • NumberConstantReader
  • StringConstantReader
  • NegatedExpressionReader with DefaultTokens.NEGATION
  • ParenthesisedExpressionReader with DefaultTokens.OPENING_PARENTHESIS and DefaultTokens.CLOSING_PARENTHESIS
  • NegatedNumberReader with DefaultTokens.SUBTRACT

Returns:

This Builder instance with default values applied. Useful for chaining.

addDefaults

public ExpressionParserEngine.Builder<T> addDefaults()

Applies default values for this Builder class to use. Namely:

• TokenReader instances:
  • PatternTokenReader with BooleanToken.TRUE for pattern true
  • PatternTokenReader with BooleanToken.FALSE for pattern false
  • PatternTokenReader with DefaultTokens.AND for patterns and and &&
  • PatternTokenReader with DefaultTokens.OR for patterns or and ||
  • PatternTokenReader with DefaultTokens.EQUAL for patterns = and ==
  • PatternTokenReader with DefaultTokens.EQUAL_IGNORE_CASE for patterns ~ and =~
  • PatternTokenReader with DefaultTokens.NOT_EQUAL for pattern !=
  • PatternTokenReader with DefaultTokens.NOT_EQUAL_IGNORE_CASE for pattern !~
  • PatternTokenReader with DefaultTokens.STARTS_WITH for pattern |-
  • PatternTokenReader with DefaultTokens.ENDS_WITH for pattern -|
  • PatternTokenReader with DefaultTokens.CONTAINS for pattern <_
  • PatternTokenReader with DefaultTokens.GREATER_THAN for pattern >
  • PatternTokenReader with DefaultTokens.GREATER_OR_EQUAL_THAN for pattern >=
  • PatternTokenReader with DefaultTokens.LESS_THAN for pattern <
  • PatternTokenReader with DefaultTokens.LESS_OR_EQUAL_THAN for pattern <=
  • PatternTokenReader with DefaultTokens.OPENING_PARENTHESIS for pattern (
  • PatternTokenReader with DefaultTokens.CLOSING_PARENTHESIS for pattern )
  • PatternTokenReader with DefaultTokens.NEGATION for pattern !
  • PatternTokenReader with DefaultTokens.CONCAT_STRING for pattern .
  • PatternTokenReader with DefaultTokens.ADD for pattern +
  • PatternTokenReader with DefaultTokens.SUBTRACT for pattern -
  • PatternTokenReader with DefaultTokens.MULTIPLY for pattern *
  • PatternTokenReader with DefaultTokens.DIVIDE for pattern /
  • QuotedLiteralTokenReader with chars " and ', and priority -10
  • NumberTokenReader with priority -50
  • NonQuotedLiteralTokenReader with priority -100
• Operators:
  • ListOperator with priority 100 and ExpressionTemplates.and(Collection) for DefaultTokens.AND
  • ListOperator with priority 50 and ExpressionTemplates.or(Collection) for DefaultTokens.OR
  • Operator with priority 25 and ExpressionTemplates.equal(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.EQUAL
  • Operator with priority 25 and ExpressionTemplates.equalIgnoreCase(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.EQUAL_IGNORE_CASE
  • Operator with priority 25 and ExpressionTemplates.notEqual(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.NOT_EQUAL
  • Operator with priority 25 and ExpressionTemplates.notEqualIgnoreCase(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.NOT_EQUAL_IGNORE_CASE
  • Operator with priority 25 and ExpressionTemplates.startsWith(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.STARTS_WITH
  • Operator with priority 25 and ExpressionTemplates.endsWith(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.ENDS_WITH
  • Operator with priority 25 and ExpressionTemplates.contains(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.CONTAINS
  • Operator with priority 25 and ExpressionTemplates.greater(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.GREATER_THAN
  • Operator with priority 25 and ExpressionTemplates.greaterOrEqual(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.GREATER_OR_EQUAL_THAN
  • Operator with priority 25 and ExpressionTemplates.less(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.LESS_THAN
  • Operator with priority 25 and ExpressionTemplates.lessOrEqual(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.LESS_OR_EQUAL_THAN
  • ListOperator with priority 10 and ExpressionTemplates.concat(Collection) for DefaultTokens.CONCAT_STRING
  • ListOperator with priority 4 and ExpressionTemplates.sum(Collection) for DefaultTokens.ADD
  • Operator with priority 3 and ExpressionTemplates.sub(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.SUBTRACT
  • ListOperator with priority 2 and ExpressionTemplates.product(Collection) for DefaultTokens.MULTIPLY
  • Operator with priority 1 and ExpressionTemplates.div(ExpressionTemplate, ExpressionTemplate) for DefaultTokens.DIVIDE
• ValueReaders:
  • BooleanConstantReader
  • NumberConstantReader
  • StringConstantReader
  • NegatedExpressionReader with DefaultTokens.NEGATION
  • ParenthesisedExpressionReader with DefaultTokens.OPENING_PARENTHESIS and DefaultTokens.CLOSING_PARENTHESIS
  • NegatedNumberReader with DefaultTokens.SUBTRACT

Returns:

This Builder instance with default values applied. Useful for chaining.

getTokenReaders

public List<TokenReader> getTokenReaders()

Returns a List of currently set TokenReaders.

Returns:

Possibly-empty List of TokenReaders.

getOperators

public Map<Token,Operator> getOperators()

Returns a Map of currently set Tokens and Operators.

Returns:

Possibly-empty Map of Tokens and Operators.

getValueReaders

public List<ValueReader> getValueReaders()

Returns a List of currently set ValueReaders.

Returns:

Possibly-empty List of ValueReaders.

addTokenReader

public ExpressionParserEngine.Builder<T> addTokenReader(TokenReader tokenReader)

Adds a new TokenReader instance to use by the DefaultExpressionParserEngine.

Parameters:

tokenReader - The TokenReader instance to add.

Returns:

This builder instance after adding the TokenReader. Useful for chaining.

addOperator

public ExpressionParserEngine.Builder<T> addOperator(Token token,
 Operator operator)

Adds a new Token instance as key with a new Operator instance as value to use by the DefaultExpressionParserEngine.

Parameters:

token - The Token instance to add as key.

operator - The Operator instance to use as value.

Returns:

This builder instance after adding the Token and Operator. Useful for chaining.

addValueReader

public ExpressionParserEngine.Builder<T> addValueReader(ValueReader valueReader)

Adds a new ValueReader instance to use by the DefaultExpressionParserEngine.

Parameters:

valueReader - The ValueReader instance to add.

Returns:

This builder instance after adding the ValueReader. Useful for chaining.

build

public abstract T build()

Method to build a new instance of what this Builder is using.

Returns:

New instance of T.