org.raml.yagi.framework.grammar.rule

Class StringTypeRule

java.lang.Object

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

org.raml.yagi.framework.grammar.rule.AbstractTypeRule

org.raml.yagi.framework.grammar.rule.StringTypeRule

Direct Known Subclasses:

ResourceRefRule

public class StringTypeRule
extends AbstractTypeRule

Constructor Summary

Constructors

Constructor and Description
StringTypeRule()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a description of this rule
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

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

apply

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

cleanFactory, createNodeUsingFactory, getChildren, getFactory, getSuggestions, named, ruleName, then, then, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringTypeRule

public StringTypeRule()

Method Detail

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

getDescription

public String getDescription()

Description copied from class: Rule

Returns a description of this rule

Specified by:

getDescription in class Rule

Returns:

the description