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

Class ObjectRule

java.lang.Object

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

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

Direct Known Subclasses:

ParametrizedNodeReferenceRule

public class ObjectRule
extends Rule

Constructor Summary

Constructors

Constructor and Description
ObjectRule()
ObjectRule(boolean strict)

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.
String	getDescription()
protected Node	getResult(Node node)
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
boolean	matches(Node node) Check if the current rule matches the specified node
ObjectRule	merge(ObjectRule objectRule)
void	setAllowsAdditionalProperties(boolean allowsAdditionalProperties)
void	setStrict(boolean strict)
ObjectRule	then(Class<? extends Node> clazz)
ObjectRule	then(NodeFactory factory)
ObjectRule	with(ConditionalRules conditional)
ObjectRule	with(KeyValueRule field)

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

createNodeUsingFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectRule

public ObjectRule()

ObjectRule

public ObjectRule(boolean strict)

Method Detail

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

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

getResult

protected Node getResult(Node node)

then

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

Overrides:

then in class Rule

then

public ObjectRule then(NodeFactory factory)

Overrides:

then in class Rule

with

public ObjectRule with(KeyValueRule field)

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

getDescription

public String getDescription()

Specified by:

getDescription in class Rule

setStrict

public void setStrict(boolean strict)

setAllowsAdditionalProperties

public void setAllowsAdditionalProperties(boolean allowsAdditionalProperties)

with

public ObjectRule with(ConditionalRules conditional)

merge

public ObjectRule merge(ObjectRule objectRule)