org.sonar.plugins.javascript.api

Class CustomJavaScriptRulesDefinition

java.lang.Object

org.sonar.plugins.javascript.api.CustomJavaScriptRulesDefinition

All Implemented Interfaces:

org.sonar.api.BatchComponent, org.sonar.api.BatchExtension, org.sonar.api.Extension, org.sonar.api.server.rule.RulesDefinition, org.sonar.api.ServerComponent, org.sonar.api.ServerExtension

@Beta
public abstract class CustomJavaScriptRulesDefinition
extends Object
implements org.sonar.api.server.rule.RulesDefinition, org.sonar.api.BatchExtension

Extension point to create custom rule repository for JavaScript.

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.Param, org.sonar.api.server.rule.RulesDefinition.Repository, org.sonar.api.server.rule.RulesDefinition.RepositoryImpl, org.sonar.api.server.rule.RulesDefinition.Rule, org.sonar.api.server.rule.RulesDefinition.SubCharacteristics

Constructor Summary

Constructors

Constructor and Description
CustomJavaScriptRulesDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Class[]	checkClasses() Array of the custom rules classes.
void	define(org.sonar.api.server.rule.RulesDefinition.Context context) Defines rule repository with check metadata from check classes' annotations.
abstract String	repositoryKey() Key of the custom rule repository.
abstract String	repositoryName() Name of the custom rule repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomJavaScriptRulesDefinition

public CustomJavaScriptRulesDefinition()

Method Detail

define

public void define(org.sonar.api.server.rule.RulesDefinition.Context context)

Defines rule repository with check metadata from check classes' annotations. This method should be overridden if check metadata are provided via another format, e.g: XMl, JSON.

Specified by:

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

repositoryName

public abstract String repositoryName()

Name of the custom rule repository.

repositoryKey

public abstract String repositoryKey()

Key of the custom rule repository.

checkClasses

public abstract Class[] checkClasses()

Array of the custom rules classes.