Package org.sonar.plugins.jcl.api

Interface CustomRulesDefinition

All Superinterfaces:

org.sonar.api.server.rule.RulesDefinition

@ScannerSide
@ExtensionPoint
public interface CustomRulesDefinition
extends org.sonar.api.server.rule.RulesDefinition

Extension point to create a custom rule repository for JCL.

Nested Class Summary

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

org.sonar.api.server.rule.RulesDefinition.AbstractContext, org.sonar.api.server.rule.RulesDefinition.Context, org.sonar.api.server.rule.RulesDefinition.CweVersion, 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.NewRule, org.sonar.api.server.rule.RulesDefinition.OwaspAsvsVersion, org.sonar.api.server.rule.RulesDefinition.OwaspTop10, org.sonar.api.server.rule.RulesDefinition.OwaspTop10Version, org.sonar.api.server.rule.RulesDefinition.Param, org.sonar.api.server.rule.RulesDefinition.PciDssVersion, org.sonar.api.server.rule.RulesDefinition.Repository, org.sonar.api.server.rule.RulesDefinition.Rule

Method Summary

Modifier and Type	Method	Description
List<Class<?>>	checkClasses()	Each custom rule (check) should be implemented as a class and this method should return a list of all these classes.
String	repositoryKey()	This method should return the key of the custom rule repository.

Methods inherited from interface org.sonar.api.server.rule.RulesDefinition

define

Method Details

repositoryKey

String repositoryKey()

This method should return the key of the custom rule repository.

Returns:

the key of the custom rule repository

checkClasses

List<Class<?>> checkClasses()

Each custom rule (check) should be implemented as a class and this method should return a list of all these classes.

Returns:

a list of custom check classes