org.raml.yagi.framework.grammar.rule

Class FieldPresentRule

java.lang.Object

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

org.raml.yagi.framework.grammar.rule.FieldPresentRule

public class FieldPresentRule
extends Rule

Delegates to a rule if a selector expression returns a value

Constructor Summary

Constructors

Constructor and Description
FieldPresentRule(String selector, Rule then)

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.
String	getDescription() Returns a description of this rule
List<Suggestion>	getSuggestions(List<Node> pathToRoot, ParsingContext context) Returns the list of suggestions after navigating through the path
List<Suggestion>	getSuggestions(Node node, ParsingContext context) Returns the suggestions of this specific rule
boolean	matches(Node node) Check if the current rule matches the specified node

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

cleanFactory, createNodeUsingFactory, getChildren, 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

FieldPresentRule

public FieldPresentRule(String selector,
                        Rule then)

Method Detail

getSuggestions

public List<Suggestion> getSuggestions(List<Node> pathToRoot,
                                       ParsingContext context)

Description copied from class: Rule

Returns the list of suggestions after navigating through the path

Overrides:

getSuggestions in class Rule

Parameters:

pathToRoot - The path of nodes to get of the node from where we want the suggestions

context - The parse context

Returns:

The list of suggestions

getSuggestions

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

Description copied from class: Rule

Returns the suggestions of this specific rule

Specified by:

getSuggestions in class Rule

Parameters:

node - The node

context - The parse context

Returns:

The list of suggestions for the specified rule

matches

public boolean matches(@Nonnull
                       Node node)

Description copied from class: Rule

Check if the current rule matches the specified node

Specified by:

matches in class Rule

Parameters:

node - The node to check with

Returns:

True if it matches otherwise false

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.

Specified by:

apply in class Rule

Parameters:

node - The current node

Returns:

the result of the factory or the current node

getDescription

public String getDescription()

Description copied from class: Rule

Returns a description of this rule

Specified by:

getDescription in class Rule

Returns:

the description