org.eclipse.xtext.xtext

Class RuleWithoutInstantiationInspector

java.lang.Object

org.eclipse.emf.ecore.util.Switch<T>

org.eclipse.xtext.util.XtextSwitch<Result>

org.eclipse.xtext.xtext.XtextRuleInspector<Boolean,ParserRule>

org.eclipse.xtext.xtext.RuleWithoutInstantiationInspector

public class RuleWithoutInstantiationInspector
extends XtextRuleInspector<Boolean,ParserRule>

Checks if a parser rule ensures object instantiation. A rule that can be consumed without instantiating an object or providing an object that was instantiated by another unassigned called rule, is considered to be invalid as it leads to surprises when clients traverse the model.

Author:

Sebastian Zarnekow - Initial contribution and API

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISSUE_CODE

Fields inherited from class org.eclipse.xtext.util.XtextSwitch

modelPackage

Constructor Summary

Constructors

Constructor and Description
RuleWithoutInstantiationInspector(ValidationMessageAcceptor acceptor)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canInspect(ParserRule rule)
Boolean	caseAbstractElement(AbstractElement object) Returns the result of interpreting the object as an instance of 'Abstract Element'
Boolean	caseAction(Action object) Returns the result of interpreting the object as an instance of 'Action'
Boolean	caseAlternatives(Alternatives object) Returns the result of interpreting the object as an instance of 'Alternatives'
Boolean	caseAssignment(Assignment object) Returns the result of interpreting the object as an instance of 'Assignment'
Boolean	caseCompoundElement(CompoundElement object) Returns the result of interpreting the object as an instance of 'Compound Element'
Boolean	caseRuleCall(RuleCall object) Returns the result of interpreting the object as an instance of 'Rule Call'
protected String	getIssueCode()
protected void	handleResult(Boolean r, ParserRule rule)

Methods inherited from class org.eclipse.xtext.xtext.XtextRuleInspector

acceptError, acceptWarning, addVisited, doInspect, getNestingLevel, getTypeRefName, inspect, removeVisited

Methods inherited from class org.eclipse.xtext.util.XtextSwitch

caseAbstractMetamodelDeclaration, caseAbstractNegatedToken, caseAbstractRule, caseCharacterRange, caseCompositeCondition, caseCondition, caseConjunction, caseCrossReference, caseDisjunction, caseEnumLiteralDeclaration, caseEnumRule, caseEOF, caseGeneratedMetamodel, caseGrammar, caseGroup, caseKeyword, caseLiteralCondition, caseNamedArgument, caseNegatedToken, caseNegation, caseParameter, caseParameterReference, caseParserRule, caseReferencedMetamodel, caseTerminalRule, caseTypeRef, caseUnorderedGroup, caseUntilToken, caseWildcard, defaultCase, doSwitch, isSwitchFor

Methods inherited from class org.eclipse.emf.ecore.util.Switch

doSwitch, doSwitch

Methods inherited from class java.lang.Object

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

Field Detail

ISSUE_CODE

public static final String ISSUE_CODE

See Also:

Constant Field Values

Constructor Detail

RuleWithoutInstantiationInspector

public RuleWithoutInstantiationInspector(ValidationMessageAcceptor acceptor)

Method Detail

getIssueCode

protected String getIssueCode()

Overrides:

getIssueCode in class XtextRuleInspector<Boolean,ParserRule>

canInspect

protected boolean canInspect(ParserRule rule)

Overrides:

canInspect in class XtextRuleInspector<Boolean,ParserRule>

handleResult

protected void handleResult(Boolean r,
                ParserRule rule)

Overrides:

handleResult in class XtextRuleInspector<Boolean,ParserRule>

caseCompoundElement

public Boolean caseCompoundElement(CompoundElement object)

Description copied from class: XtextSwitch

Returns the result of interpreting the object as an instance of 'Compound Element'. This implementation returns null; returning a non-null result will terminate the switch.

Overrides:

caseCompoundElement in class XtextSwitch<Boolean>

Parameters:

object - the target of the switch.

Returns:

the result of interpreting the object as an instance of 'Compound Element'.

See Also:

doSwitch(EObject)

caseAbstractElement

public Boolean caseAbstractElement(AbstractElement object)

Description copied from class: XtextSwitch

Returns the result of interpreting the object as an instance of 'Abstract Element'. This implementation returns null; returning a non-null result will terminate the switch.

Overrides:

caseAbstractElement in class XtextSwitch<Boolean>

Parameters:

object - the target of the switch.

Returns:

the result of interpreting the object as an instance of 'Abstract Element'.

See Also:

doSwitch(EObject)

caseAction

public Boolean caseAction(Action object)

Description copied from class: XtextSwitch

Returns the result of interpreting the object as an instance of 'Action'. This implementation returns null; returning a non-null result will terminate the switch.

Overrides:

caseAction in class XtextSwitch<Boolean>

Parameters:

object - the target of the switch.

Returns:

the result of interpreting the object as an instance of 'Action'.

See Also:

doSwitch(EObject)

caseAlternatives

public Boolean caseAlternatives(Alternatives object)

Description copied from class: XtextSwitch

Returns the result of interpreting the object as an instance of 'Alternatives'. This implementation returns null; returning a non-null result will terminate the switch.

Overrides:

caseAlternatives in class XtextSwitch<Boolean>

Parameters:

object - the target of the switch.

Returns:

the result of interpreting the object as an instance of 'Alternatives'.

See Also:

doSwitch(EObject)

caseAssignment

public Boolean caseAssignment(Assignment object)

Description copied from class: XtextSwitch

Returns the result of interpreting the object as an instance of 'Assignment'. This implementation returns null; returning a non-null result will terminate the switch.

Overrides:

caseAssignment in class XtextSwitch<Boolean>

Parameters:

object - the target of the switch.

Returns:

the result of interpreting the object as an instance of 'Assignment'.

See Also:

doSwitch(EObject)

caseRuleCall

public Boolean caseRuleCall(RuleCall object)

Description copied from class: XtextSwitch

Returns the result of interpreting the object as an instance of 'Rule Call'. This implementation returns null; returning a non-null result will terminate the switch.

Overrides:

caseRuleCall in class XtextSwitch<Boolean>

Parameters:

object - the target of the switch.

Returns:

the result of interpreting the object as an instance of 'Rule Call'.

See Also:

doSwitch(EObject)