Package jetbrains.mps.generator.runtime

Class MapRootRuleBase

java.lang.Object

jetbrains.mps.generator.runtime.MapRootRuleBase

All Implemented Interfaces:

TemplateRootMappingRule, TemplateRule, TemplateRuleForConcept, TemplateRuleWithCondition

Direct Known Subclasses:

TemplateRootMappingRuleInterpreted

public abstract class MapRootRuleBase
extends Object
implements TemplateRootMappingRule

Base implementation of TemplateRootMappingRule to use as superclass in generated code to facilitate future API changes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapRootRuleBase(SNodeReference ruleNode, SAbstractConcept appConcept, boolean applyToSubConcepts, boolean keepSourceRoot)

Method Summary

Modifier and Type	Method	Description
boolean	applyToInheritors()
SAbstractConcept	getApplicableConcept()
SNodeReference	getRuleNode()
boolean	isApplicable(TemplateContext context)	Default implementation subclasses can rely on, always true
boolean	keepSourceRoot()

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.mps.generator.runtime.TemplateRootMappingRule

apply

Constructor Detail

MapRootRuleBase

protected MapRootRuleBase(@NotNull
                          SNodeReference ruleNode,
                          @NotNull
                          SAbstractConcept appConcept,
                          boolean applyToSubConcepts,
                          boolean keepSourceRoot)

Parameters:

ruleNode - identifies rule for navigation/error reporting

appConcept - concept to trigger rule

applyToSubConcepts - true to apply to appConcept's sub-concepts

keepSourceRoot - true to preserve root in input model for further processing

Since:

3.3

Method Detail

getApplicableConcept

@NotNull
public final SAbstractConcept getApplicableConcept()

Specified by:

getApplicableConcept in interface TemplateRuleForConcept

Returns:

concept to trigger this rule

applyToInheritors

public boolean applyToInheritors()

Specified by:

applyToInheritors in interface TemplateRuleForConcept

getRuleNode

@NotNull
public SNodeReference getRuleNode()

Specified by:

getRuleNode in interface TemplateRule

keepSourceRoot

public boolean keepSourceRoot()

Specified by:

keepSourceRoot in interface TemplateRootMappingRule

isApplicable

public boolean isApplicable(@NotNull
                            TemplateContext context)
                     throws GenerationException

Default implementation subclasses can rely on, always true

Specified by:

isApplicable in interface TemplateRuleWithCondition

Throws:

GenerationException