Package com.thomasjensen.checkstyle.addons.sonarqube

Class AbstractRuleBase

java.lang.Object

com.thomasjensen.checkstyle.addons.sonarqube.AbstractRuleBase

All Implemented Interfaces:

org.sonar.api.server.rule.RulesDefinition

Direct Known Subclasses:

IllegalMethodCallRule, LocationReferenceRule, LostInstanceRule, ModuleDirectoryLayoutRule, PropertyCatalogRule, RegexpOnFilenameOrgRule, RegexpOnStringRule

public abstract class AbstractRuleBase
extends Object
implements org.sonar.api.server.rule.RulesDefinition

Common superclass of all our SonarQube rules.

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.api.server.rule.RulesDefinition

org.sonar.api.server.rule.RulesDefinition.Context, org.sonar.api.server.rule.RulesDefinition.DebtRemediationFunctions, org.sonar.api.server.rule.RulesDefinition.ExtendedRepository, org.sonar.api.server.rule.RulesDefinition.NewExtendedRepository, org.sonar.api.server.rule.RulesDefinition.NewParam, org.sonar.api.server.rule.RulesDefinition.NewRepository, org.sonar.api.server.rule.RulesDefinition.NewRepositoryImpl, org.sonar.api.server.rule.RulesDefinition.NewRule, org.sonar.api.server.rule.RulesDefinition.OwaspTop10, org.sonar.api.server.rule.RulesDefinition.Param, org.sonar.api.server.rule.RulesDefinition.Repository, org.sonar.api.server.rule.RulesDefinition.RepositoryImpl, org.sonar.api.server.rule.RulesDefinition.Rule

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRuleBase(org.sonar.api.server.rule.RulesDefinition.NewRepository pSqRepo, String pCheckstyleAddonsVersion, boolean pShouldRunOnTestCode)

Method Summary

Modifier and Type	Method	Description
void	define(org.sonar.api.server.rule.RulesDefinition.Context pContext)
protected abstract void	defineRule(org.sonar.api.server.rule.RulesDefinition.NewRule pNewRule, String pCheckstyleAddonsVersion)
protected abstract String	getRuleId()
protected org.sonar.api.rule.RuleKey	getRuleKey()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRuleBase

protected AbstractRuleBase(@Nonnull
                           org.sonar.api.server.rule.RulesDefinition.NewRepository pSqRepo,
                           @Nonnull
                           String pCheckstyleAddonsVersion,
                           boolean pShouldRunOnTestCode)

Method Detail

getRuleKey

@Nonnull
protected final org.sonar.api.rule.RuleKey getRuleKey()

getRuleId

@Nonnull
protected abstract String getRuleId()

define

public final void define(@Nonnull
                         org.sonar.api.server.rule.RulesDefinition.Context pContext)

Specified by:

define in interface org.sonar.api.server.rule.RulesDefinition

defineRule

protected abstract void defineRule(@Nonnull
                                   org.sonar.api.server.rule.RulesDefinition.NewRule pNewRule,
                                   @Nonnull
                                   String pCheckstyleAddonsVersion)