Package org.sonar.api.server.rule

Class RulesDefinition.AbstractContext

java.lang.Object

org.sonar.api.server.rule.RulesDefinition.AbstractContext

Direct Known Subclasses:

RulesDefinition.Context

Enclosing interface:

RulesDefinition

public abstract static class RulesDefinition.AbstractContext
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor	Description
AbstractContext()

Method Summary

Modifier and Type	Method	Description
abstract RulesDefinition.NewRepository	createExternalRepository(java.lang.String engineId, java.lang.String language)	Creates a repository of rules from external rule engines.
abstract RulesDefinition.NewRepository	createRepository(java.lang.String key, java.lang.String language)
abstract java.util.List<RulesDefinition.ExtendedRepository>	extendedRepositories()	Deprecated. returns empty list since 5.2.
abstract java.util.List<RulesDefinition.ExtendedRepository>	extendedRepositories(java.lang.String repositoryKey)	Deprecated. returns empty list since 5.2.
abstract RulesDefinition.NewRepository	extendRepository(java.lang.String key, java.lang.String language)	Deprecated. since 5.2.
abstract java.util.List<RulesDefinition.Repository>	repositories()
abstract RulesDefinition.Repository	repository(java.lang.String key)
abstract void	setCurrentPluginKey(java.lang.String pluginKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractContext

public AbstractContext()

Method Detail

createRepository

public abstract RulesDefinition.NewRepository createRepository(java.lang.String key,
                                                               java.lang.String language)

createExternalRepository

public abstract 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 abstract RulesDefinition.NewRepository extendRepository(java.lang.String key,
                                                               java.lang.String language)

Deprecated.

since 5.2. Simply use createRepository(String, String)

repository

@CheckForNull
public abstract RulesDefinition.Repository repository(java.lang.String key)

repositories

public abstract java.util.List<RulesDefinition.Repository> repositories()

extendedRepositories

@Deprecated
public abstract 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 use repositories(). See http://jira.sonarsource.com/browse/SONAR-6709

extendedRepositories

@Deprecated
public abstract 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 use repositories(). See http://jira.sonarsource.com/browse/SONAR-6709

setCurrentPluginKey

public abstract void setCurrentPluginKey(@Nullable
                                         java.lang.String pluginKey)