org.sonar.api.server.rule

Class RulesDefinition.Context

java.lang.Object

org.sonar.api.server.rule.RulesDefinition.Context

Enclosing interface:

RulesDefinition

public static class RulesDefinition.Context
extends Object

Instantiated by core but not by plugins, except for their tests.

Constructor Summary

Constructors

Constructor and Description
Context()

Method Summary

Modifier and Type	Method and Description
RulesDefinition.NewRepository	createRepository(String key, String language) New builder for RulesDefinition.Repository.
List<RulesDefinition.ExtendedRepository>	extendedRepositories() Deprecated. returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use repositories(). See http://jira.sonarsource.com/browse/SONAR-6709
List<RulesDefinition.ExtendedRepository>	extendedRepositories(String repositoryKey) Deprecated. returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use repositories(). See http://jira.sonarsource.com/browse/SONAR-6709
RulesDefinition.NewRepository	extendRepository(String key, String language) Deprecated. since 5.2. Simply use createRepository(String, String)
List<RulesDefinition.Repository>	repositories()
RulesDefinition.Repository	repository(String key)

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context()

Method Detail

createRepository

public RulesDefinition.NewRepository createRepository(String key,
                                                      String language)

New builder for RulesDefinition.Repository.
A plugin can add rules to a repository that is defined then executed by another plugin. For instance the FbContrib plugin contributes to the Findbugs plugin rules. In this case no need to execute RulesDefinition.NewRepository.setName(String)

extendRepository

@Deprecated
public RulesDefinition.NewRepository extendRepository(String key,
                                                                  String language)

Deprecated. since 5.2. Simply use createRepository(String, String)

repository

@CheckForNull
public RulesDefinition.Repository repository(String key)

repositories

public List<RulesDefinition.Repository> repositories()

extendedRepositories

@Deprecated
public List<RulesDefinition.ExtendedRepository> extendedRepositories(String repositoryKey)

Deprecated. returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use repositories(). See http://jira.sonarsource.com/browse/SONAR-6709

extendedRepositories

@Deprecated
public List<RulesDefinition.ExtendedRepository> extendedRepositories()

Deprecated. returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and use repositories(). See http://jira.sonarsource.com/browse/SONAR-6709