com.sonar.sslr.impl.matcher

Class RuleDefinition

java.lang.Object

com.sonar.sslr.impl.matcher.RuleDefinition

All Implemented Interfaces:

AstNodeSkippingPolicy, AstNodeType, Rule

public final class RuleDefinition
extends java.lang.Object
implements Rule, AstNodeSkippingPolicy

Method Summary

Methods

Modifier and Type	Method and Description
RuleMatcher	getRule()
boolean	hasToBeSkippedFromAst(AstNode node) Some AstNode can be pretty useless and makes a global AST less readable.
RuleDefinition	is(java.lang.Object... matchers) This method allows to provide the definition of a context-free grammar rule.
void	mock() Utility method used for unit testing in order to dynamically replace the definition of the rule to match as soon as a token whose value equals the name of the rule is encountered
static RuleDefinition	newRuleBuilder(RuleMatcher ruleMatcher)
static RuleDefinition	newRuleBuilder(java.lang.String ruleName)
RuleDefinition	override(java.lang.Object... matchers) This method has the same effect as RuleImpl#is(Object...), except that it can be called more than once to redefine a rule from scratch.
void	recoveryRule() A rule should be flagged as being a "Recovery" rule if it's responsibility is to consume some bad tokens in order to recover from a parsing error.
protected void	setMatcher(Matcher matcher)
void	setRuleMatcher(RuleMatcher ruleMatcher)
void	skip() Remove this node from the AST and attached its children directly to its parent
void	skipIf(AstNodeSkippingPolicy astNodeSkipPolicy) Remove this node from the AST according to a provided policy
void	skipIfOneChild() Remove this node from the AST if it has exactly 1 child
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newRuleBuilder

public static RuleDefinition newRuleBuilder(java.lang.String ruleName)

newRuleBuilder

public static RuleDefinition newRuleBuilder(RuleMatcher ruleMatcher)

getRule

public RuleMatcher getRule()

setRuleMatcher

public void setRuleMatcher(RuleMatcher ruleMatcher)

is

public RuleDefinition is(java.lang.Object... matchers)

Description copied from interface: Rule

This method allows to provide the definition of a context-free grammar rule.

Note: this method can be called only once for a rule. If it is called more than once, an IllegalStateException will be thrown. If the rule definition really needs to be redefine, then the Rule.override(Object...) method must be used.

Specified by:

is in interface Rule

Parameters:

matchers - the matchers that define the rule

Returns:

this rule

override

public RuleDefinition override(java.lang.Object... matchers)

Description copied from interface: Rule

This method has the same effect as RuleImpl#is(Object...), except that it can be called more than once to redefine a rule from scratch. It can be used if the rule has to be redefined later (for instance in a grammar extension).

Specified by:

override in interface Rule

Parameters:

matchers - the matchers that define the rule

Returns:

this rule

mock

public void mock()

Description copied from interface: Rule

Utility method used for unit testing in order to dynamically replace the definition of the rule to match as soon as a token whose value equals the name of the rule is encountered

Specified by:

mock in interface Rule

skip

public void skip()

Description copied from interface: Rule

Remove this node from the AST and attached its children directly to its parent

Specified by:

skip in interface Rule

setMatcher

protected void setMatcher(Matcher matcher)

skipIf

public void skipIf(AstNodeSkippingPolicy astNodeSkipPolicy)

Description copied from interface: Rule

Remove this node from the AST according to a provided policy

Specified by:

skipIf in interface Rule

skipIfOneChild

public void skipIfOneChild()

Description copied from interface: Rule

Remove this node from the AST if it has exactly 1 child

Specified by:

skipIfOneChild in interface Rule

recoveryRule

public void recoveryRule()

Description copied from interface: Rule

A rule should be flagged as being a "Recovery" rule if it's responsibility is to consume some bad tokens in order to recover from a parsing error. In such case, all RecognitionExceptionListener injected into the Parser are automatically notified.

Specified by:

recoveryRule in interface Rule

See Also:

RecognitionExceptionListener

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hasToBeSkippedFromAst

public boolean hasToBeSkippedFromAst(AstNode node)

Description copied from interface: AstNodeSkippingPolicy

Some AstNode can be pretty useless and makes a global AST less readable. This method allows to automatically remove those AstNode from the AST.

Specified by:

hasToBeSkippedFromAst in interface AstNodeSkippingPolicy

Parameters:

node - the node that should or not be removed from the AST

Returns:

true if AstNode with this type must be skipped from the AST.