Package software.amazon.smithy.rulesengine.language.syntax.rule

Class Rule.Builder

java.lang.Object

software.amazon.smithy.rulesengine.language.syntax.rule.Rule.Builder

Enclosing class:

Rule

public static final class Rule.Builder
extends java.lang.Object

A builder used to create a Rule class.

Method Summary

Modifier and Type	Method	Description
Rule.Builder	condition(ToCondition condition)
Rule.Builder	conditions(java.util.List<ToCondition> conditions)
Rule.Builder	conditions(ToCondition... conditions)
Rule.Builder	description(java.lang.String description)
Rule	endpoint(Endpoint endpoint)
Rule	error(java.lang.String error)
Rule	error(Node error)
Rule.Builder	errorOrElse(java.lang.String error, ToCondition... condition)	If `condition` IS met, return an error.
Rule	treeRule(java.util.List<Rule>... rules)
Rule	treeRule(Rule... rules)
Rule.Builder	validateOrElse(java.lang.String error, ToCondition... condition)	If `condition` IS NOT met, return an error.

Methods inherited from class java.lang.Object

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

Method Detail

conditions

public Rule.Builder conditions(ToCondition... conditions)

conditions

public Rule.Builder conditions(java.util.List<ToCondition> conditions)

condition

public Rule.Builder condition(ToCondition condition)

endpoint

public Rule endpoint(Endpoint endpoint)

error

public Rule error(Node error)

error

public Rule error(java.lang.String error)

treeRule

public Rule treeRule(Rule... rules)

treeRule

@SafeVarargs
public final Rule treeRule(java.util.List<Rule>... rules)

description

public Rule.Builder description(java.lang.String description)

errorOrElse

public Rule.Builder errorOrElse(java.lang.String error,
                                ToCondition... condition)

If `condition` IS met, return an error. Otherwise, proceed with the rules generated by the returned builder.

This method returns a new builder that must be used!

Parameters:

condition - a coercible Condition

error - an error description if the condition is not matched

Returns:

new builder to attach subsequent rules to

validateOrElse

public Rule.Builder validateOrElse(java.lang.String error,
                                   ToCondition... condition)

If `condition` IS NOT met, return an error. Otherwise, proceed with the rules generated by the returned builder.

This method returns a new builder that must be used!

Parameters:

condition - a coercible Condition

error - an error description if the condition is not matched

Returns:

new builder to attach subsequent rules to