io.appform.hope.lang

Class HopeLangEngine

java.lang.Object

io.appform.hope.lang.HopeLangEngine

public class HopeLangEngine
extends Object

Top level accessor for hope. Creation is expensive. Create and reuse.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HopeLangEngine.Builder

Method Summary

Modifier and Type	Method and Description
static HopeLangEngine.Builder	builder() Create a builder for the parser.
boolean	evaluate(io.appform.hope.core.Evaluatable rule, com.fasterxml.jackson.databind.JsonNode node) Evaluate a hope lang parsed expression
boolean	evaluate(String hopeLangExpression, com.fasterxml.jackson.databind.JsonNode root) Evaluates a hope expression using the provided json to return true or false.
io.appform.hope.core.Evaluatable	parse(String hopeLangExpression) Parse a hope lang string.

Methods inherited from class java.lang.Object

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

Method Detail

evaluate

public boolean evaluate(String hopeLangExpression,
                        com.fasterxml.jackson.databind.JsonNode root)

Evaluates a hope expression using the provided json to return true or false.

Parameters:

hopeLangExpression - A hope language expression

root - The json node to be evaluated

Returns:

true in case of match

parse

public io.appform.hope.core.Evaluatable parse(String hopeLangExpression)
                                       throws io.appform.hope.core.exceptions.impl.HopeExpressionParserError

Parse a hope lang string. The resultant parsed rule can be reused for multiple evaluations.

Parameters:

hopeLangExpression - Parse a string

Returns:

An evaluatable expression tree

Throws:

io.appform.hope.core.exceptions.impl.HopeExpressionParserError

evaluate

public boolean evaluate(io.appform.hope.core.Evaluatable rule,
                        com.fasterxml.jackson.databind.JsonNode node)

Evaluate a hope lang parsed expression

Parameters:

rule - Parsed rule

node - JsonNode for which the match rule is to be evaluated

Returns:

true in case of match

builder

public static HopeLangEngine.Builder builder()

Create a builder for the parser.

Returns:

An initialized builder.