org.raml.yagi.framework.grammar.rule

Class Rule

java.lang.Object

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

Direct Known Subclasses:

AbstractTypeRule, AllOfRule, AnyOfRule, AnyValueRule, ArrayRule, ChildBasedConditionalRule, DateValueRule, DivisorValueRule, ExclusiveSiblingRule, FieldPresentRule, IntegerValueRule, KeyValueRule, MaximumValueRule, MaxItemsRule, MaxLengthRule, MaxPropertiesRule, MinimumValueRule, MinItemsRule, MinLengthRule, MinPropertiesRule, NegativeRule, NullValueRule, ObjectRule, RangeValueRule, RegexValueRule, StringValueRule

public abstract class Rule
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rule()

Method Summary

Modifier and Type	Method and Description
abstract 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.
Rule	cleanFactory()
protected Node	createNodeUsingFactory(Node currentNode, Object... args)
List<? extends Rule>	getChildren()
abstract String	getDescription() Returns a description of this rule
NodeFactory	getFactory()
List<Suggestion>	getSuggestions(List<Node> pathToRoot, ParsingContext context) Returns the list of suggestions after navigating through the path
abstract List<Suggestion>	getSuggestions(Node node, ParsingContext context) Returns the suggestions of this specific rule
abstract boolean	matches(Node node) Check if the current rule matches the specified node
Rule	named(String ruleName)
String	ruleName()
Rule	then(Class<? extends Node> clazz) Sets the clazz of the node that is going to be created to replaced the matched node of this rule.
Rule	then(NodeFactory factory) Sets the factory of the node that is going to be created to replaced the matched node of this rule.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

protected Rule()

Method Detail

getChildren

public List<? extends Rule> getChildren()

named

public Rule named(String ruleName)

ruleName

public String ruleName()

toString

public String toString()

Overrides:

toString in class Object

matches

public abstract boolean matches(@Nonnull
                                Node node)

Check if the current rule matches the specified node

Parameters:

node - The node to check with

Returns:

True if it matches otherwise false

apply

@Nonnull
public abstract Node apply(@Nonnull
                                    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.

Parameters:

node - The current node

Returns:

the result of the factory or the current node

getDescription

public abstract String getDescription()

Returns a description of this rule

Returns:

the description

getFactory

@Nullable
public NodeFactory getFactory()

createNodeUsingFactory

@Nonnull
protected Node createNodeUsingFactory(@Nonnull
                                               Node currentNode,
                                               Object... args)

then

public Rule then(Class<? extends Node> clazz)

Sets the clazz of the node that is going to be created to replaced the matched node of this rule. This is only applied if the rule matches

Parameters:

clazz - The class of the node

Returns:

this

then

public Rule then(NodeFactory factory)

Sets the factory of the node that is going to be created to replaced the matched node of this rule. This is only applied if the rule matches

Parameters:

factory - The class of the node

Returns:

this

cleanFactory

public Rule cleanFactory()

getSuggestions

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

Returns the list of suggestions after navigating through the path

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 abstract List<Suggestion> getSuggestions(Node node,
                                                         ParsingContext context)

Returns the suggestions of this specific rule

Parameters:

node - The node

context - The parse context

Returns:

The list of suggestions for the specified rule