Package 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 java.lang.Object
Instantiated by core but not by plugins, except for their tests.
-
-
Constructor Summary
Constructors Constructor Description Context()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RulesDefinition.NewRepository
createExternalRepository(java.lang.String engineId, java.lang.String language)
Creates a repository of rules from external rule engines.RulesDefinition.NewRepository
createRepository(java.lang.String key, java.lang.String language)
New builder forRulesDefinition.Repository
.java.util.List<RulesDefinition.ExtendedRepository>
extendedRepositories()
Deprecated.returns empty list since 5.2.java.util.List<RulesDefinition.ExtendedRepository>
extendedRepositories(java.lang.String repositoryKey)
Deprecated.returns empty list since 5.2.RulesDefinition.NewRepository
extendRepository(java.lang.String key, java.lang.String language)
Deprecated.since 5.2.java.util.List<RulesDefinition.Repository>
repositories()
RulesDefinition.Repository
repository(java.lang.String key)
void
setCurrentPluginKey(java.lang.String pluginKey)
-
-
-
Method Detail
-
createRepository
public RulesDefinition.NewRepository createRepository(java.lang.String key, java.lang.String language)
New builder forRulesDefinition.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 executeRulesDefinition.NewRepository.setName(String)
-
createExternalRepository
public RulesDefinition.NewRepository createExternalRepository(java.lang.String engineId, java.lang.String language)
Creates a repository of rules from external rule engines. The repository key will be "external_[engineId]".- Since:
- 7.2
-
extendRepository
@Deprecated public RulesDefinition.NewRepository extendRepository(java.lang.String key, java.lang.String language)
Deprecated.since 5.2. Simply usecreateRepository(String, String)
-
repository
@CheckForNull public RulesDefinition.Repository repository(java.lang.String key)
-
repositories
public java.util.List<RulesDefinition.Repository> repositories()
-
extendedRepositories
@Deprecated public java.util.List<RulesDefinition.ExtendedRepository> extendedRepositories(java.lang.String repositoryKey)
Deprecated.returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and userepositories()
. See http://jira.sonarsource.com/browse/SONAR-6709
-
extendedRepositories
@Deprecated public java.util.List<RulesDefinition.ExtendedRepository> extendedRepositories()
Deprecated.returns empty list since 5.2. Concept of "extended repository" was misleading and not valuable. Simply declare repositories and userepositories()
. See http://jira.sonarsource.com/browse/SONAR-6709
-
setCurrentPluginKey
public void setCurrentPluginKey(@Nullable java.lang.String pluginKey)
-
-