org.raml.yagi.framework.grammar.rule

Class ObjectRule

java.lang.Object

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

org.raml.yagi.framework.grammar.rule.ObjectRule

public class ObjectRule
extends Rule

Constructor Summary

Constructors

Constructor and Description
ObjectRule()
ObjectRule(boolean strict)

Method Summary

Modifier and Type	Method and Description
void	additionalProperties(boolean allowsAdditionalProperties)
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.
List<? extends Rule>	getChildren()
String	getDescription() Returns a description of this rule
protected Node	getResult(Node node)
List<Suggestion>	getSuggestions(List<Node> pathToRoot, ParsingContext context) Returns the list of suggestions after navigating through the path
List<Suggestion>	getSuggestions(Node node, ParsingContext context) Returns the suggestions of this specific rule
boolean	matches(Node node) Check if the current rule matches the specified node
ObjectRule	named(String ruleName)
ObjectRule	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.
ObjectRule	then(NodeFactory factory) Sets the factory of the node that is going to be created to replaced the matched node of this rule.
ObjectRule	with(ConditionalRules conditional) Defines conditional fields based on a condition.
ObjectRule	with(ExclusiveKeys exclusive) Defines the mutually exclusive fields
ObjectRule	with(int index, KeyValueRule field) Adds a field to this object rule at a given order
ObjectRule	with(KeyValueRule field) Adds a field to this object rule
ObjectRule	withAll(KeyValueRule... fields) Adds all a field to this object rule

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

cleanFactory, createNodeUsingFactory, getFactory, ruleName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectRule

public ObjectRule()

ObjectRule

public ObjectRule(boolean strict)

Method Detail

getChildren

public List<? extends Rule> getChildren()

Overrides:

getChildren in class Rule

named

public ObjectRule named(String ruleName)

Overrides:

named in class Rule

getSuggestions

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

@Nonnull
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)

Description copied from class: Rule

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

Overrides:

then in class Rule

Parameters:

clazz - The class of the node

Returns:

this

then

public ObjectRule then(NodeFactory factory)

Description copied from class: Rule

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

Overrides:

then in class Rule

Parameters:

factory - The class of the node

Returns:

this

with

public ObjectRule with(KeyValueRule field)

Adds a field to this object rule

Parameters:

field - The field defined to this object

Returns:

this

withAll

public ObjectRule withAll(KeyValueRule... fields)

Adds all a field to this object rule

Parameters:

fields - The fields defined to this object

Returns:

this

with

public ObjectRule with(int index,
                       KeyValueRule field)

Adds a field to this object rule at a given order

Parameters:

field - The field defined to this object

index - the index

Returns:

this

getSuggestions

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

Description copied from class: Rule

Returns a description of this rule

Specified by:

getDescription in class Rule

Returns:

the description

additionalProperties

public void additionalProperties(boolean allowsAdditionalProperties)

with

public ObjectRule with(ConditionalRules conditional)

Defines conditional fields based on a condition. This fields are only valid if the specified condition is

Parameters:

conditional - The conditional fields

Returns:

this

with

public ObjectRule with(ExclusiveKeys exclusive)

Defines the mutually exclusive fields

Parameters:

exclusive - The exclusive rules

Returns:

this