org.raml.yagi.framework.grammar.rule

Class FirstOfRule

java.lang.Object

org.raml.yagi.framework.grammar.rule.Rule

org.raml.yagi.framework.grammar.rule.AnyOfRule

org.raml.yagi.framework.grammar.rule.FirstOfRule

public class FirstOfRule
extends AnyOfRule

Accepts if any rule matches and delegates the suggestion to the first one that matches.

Field Summary

Fields inherited from class org.raml.yagi.framework.grammar.rule.AnyOfRule

rules

Constructor Summary

Constructors

Constructor and Description
FirstOfRule(List<Rule> rules)

Method Summary

Modifier and Type	Method and Description
Node	apply(Node node) Applies the rule to the node using the following criteria - if rule does not match returns an ErrorNode and stops processing - if rule matches, applies rules to children - if rule contains a NodeFactory, returns the result of it - else returns node Only structure rules (ObjectRule, ArrayRule, KeyValueRule) replace child nodes.
List<Suggestion>	getSuggestions(Node node, ParsingContext context) Returns the suggestions of this specific rule

Methods inherited from class org.raml.yagi.framework.grammar.rule.AnyOfRule

add, addAll, getChildren, getDescription, getMatchingRule, getRules, getSuggestions, matches

Methods inherited from class org.raml.yagi.framework.grammar.rule.Rule

cleanFactory, createNodeUsingFactory, getFactory, named, ruleName, then, then, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FirstOfRule

public FirstOfRule(List<Rule> rules)

Method Detail

getSuggestions

@Nonnull
public List<Suggestion> getSuggestions(Node node,
                                                ParsingContext context)

Description copied from class: Rule

Returns the suggestions of this specific rule

Overrides:

getSuggestions in class AnyOfRule

Parameters:

node - The node

context - The parse context

Returns:

The list of suggestions for the specified rule

apply

public Node apply(@Nonnull
                  Node node)

Description copied from class: Rule

Applies the rule to the node using the following criteria - if rule does not match returns an ErrorNode and stops processing - if rule matches, applies rules to children - if rule contains a NodeFactory, returns the result of it - else returns node

Only structure rules (ObjectRule, ArrayRule, KeyValueRule) replace child nodes.

Overrides:

apply in class AnyOfRule

Parameters:

node - The current node

Returns:

the result of the factory or the current node