org.raml.v2.grammar.rule

Class Rule

java.lang.Object

org.raml.v2.grammar.rule.Rule

Direct Known Subclasses:

AbstractTypeRule, AllOfRule, AnyOfRule, AnyValueRule, ArrayRule, DateValueRule, DiscriminatorRule, DivisorValueRule, ExampleRule, ExclusiveSiblingRule, FieldPresentRule, IntegerValueRule, JsonSchemaValidationRule, KeyValueRule, MaximumValueRule, MaxLengthRule, MinimumValueRule, MinLengthRule, NegativeRule, NullValueRule, ObjectListRule, ObjectRule, RangeValueRule, ReferenceRule, RegexValueRule, StringValueRule, XmlSchemaValidationRule

public abstract class Rule
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rule()

Method Summary

Methods

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.
Node	createNodeUsingFactory(Node currentNode, Object... args)
abstract String	getDescription()
List<Suggestion>	getSuggestions(List<Node> pathToRoot, RamlParsingContext context) Returns the list of suggestions after navigating through the path
abstract List<Suggestion>	getSuggestions(Node node, RamlParsingContext context) Returns the suggestions of this specific rule
abstract boolean	matches(Node node) Check if the current rule matches the specified node
Rule	then(Class<? extends Node> clazz)
Rule	then(NodeFactory factory)

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

protected Rule()

Method Detail

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()

createNodeUsingFactory

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

then

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

then

public Rule then(NodeFactory factory)

getSuggestions

public List<Suggestion> getSuggestions(List<Node> pathToRoot,
                              RamlParsingContext 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,
                                      RamlParsingContext 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