org.raml.v2.internal.framework.grammar.rule

Class KeyValueRule

java.lang.Object

org.raml.v2.internal.framework.grammar.rule.Rule

org.raml.v2.internal.framework.grammar.rule.KeyValueRule

public class KeyValueRule
extends Rule

Constructor Summary

Constructors

Constructor and Description
KeyValueRule(Rule keyRule, Rule valueRule)

Method Summary

Methods

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.
void	applyDefault(Node parent)
KeyValueRule	defaultValue(DefaultValue defaultValue)
KeyValueRule	description(String description)
String	getDescription()
Rule	getKeyRule()
List<Suggestion>	getKeySuggestions(Node node, RamlParsingContext context)
List<Suggestion>	getSuggestions(List<Node> pathToRoot, RamlParsingContext context) Returns the list of suggestions after navigating through the path
List<Suggestion>	getSuggestions(Node node, RamlParsingContext context) Returns the suggestions of this specific rule
Rule	getValueRule()
boolean	isRequired()
boolean	matches(Node node) Check if the current rule matches the specified node
boolean	repeated()
KeyValueRule	required()
KeyValueRule	then(Class<? extends Node> clazz)

Methods inherited from class org.raml.v2.internal.framework.grammar.rule.Rule

createNodeUsingFactory, then

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueRule

public KeyValueRule(Rule keyRule,
            Rule valueRule)

Method Detail

required

public KeyValueRule required()

getSuggestions

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

getKeySuggestions

@Nonnull
public List<Suggestion> getKeySuggestions(Node node,
                                         RamlParsingContext context)

getSuggestions

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

description

public KeyValueRule description(String description)

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

repeated

public boolean repeated()

getKeyRule

public Rule getKeyRule()

getValueRule

public Rule getValueRule()

then

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

Overrides:

then in class 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.

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

Specified by:

getDescription in class Rule

isRequired

public boolean isRequired()

defaultValue

@Nonnull
public KeyValueRule defaultValue(DefaultValue defaultValue)

applyDefault

public void applyDefault(Node parent)