org.raml.yagi.framework.grammar.rule

Class ResourceRefRule

java.lang.Object

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

org.raml.yagi.framework.grammar.rule.AbstractTypeRule

org.raml.yagi.framework.grammar.rule.StringTypeRule

org.raml.yagi.framework.grammar.rule.ResourceRefRule

public class ResourceRefRule
extends StringTypeRule

Constructor Summary

Constructors

Constructor and Description
ResourceRefRule()

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.
boolean	matches(Node node) Check if the current rule matches the specified node

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

getDescription, getSuggestions

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceRefRule

public ResourceRefRule()

Method Detail

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 AbstractTypeRule

Parameters:

node - The current node

Returns:

the result of the factory or the current node

matches

public boolean matches(@Nonnull
                       Node node)

Description copied from class: Rule

Check if the current rule matches the specified node

Overrides:

matches in class StringTypeRule

Parameters:

node - The node to check with

Returns:

True if it matches otherwise false