Package org.sonar.api.server.rule.internal

Class DefaultRule

java.lang.Object

org.sonar.api.server.rule.RulesDefinition.Rule

org.sonar.api.server.rule.internal.DefaultRule

@Immutable
public class DefaultRule
extends RulesDefinition.Rule

Method Summary

Modifier and Type	Method	Description
boolean	activatedByDefault()	Should this rule be enabled by default.
CleanCodeAttribute	cleanCodeAttribute()
DebtRemediationFunction	debtRemediationFunction()
java.util.Map<SoftwareQuality,Severity>	defaultImpacts()
java.util.Set<RuleKey>	deprecatedRuleKeys()	Deprecated rules keys for this rule.
java.util.Set<java.lang.String>	educationPrincipleKeys()
boolean	equals(java.lang.Object o)
java.lang.String	gapDescription()
int	hashCode()
java.lang.String	htmlDescription()
java.lang.String	internalKey()
java.lang.String	key()
java.lang.String	markdownDescription()	Deprecated, for removal: This API element is subject to removal in a future version. since 9.6 markdown support fur rule descriptions will be dropped
java.lang.String	name()
RulesDefinition.Param	param(java.lang.String key)
java.util.List<RulesDefinition.Param>	params()
java.lang.String	pluginKey()
RulesDefinition.Repository	repository()
java.util.List<RuleDescriptionSection>	ruleDescriptionSections()	See RulesDefinition.NewRule.addDescriptionSection(RuleDescriptionSection) to understand what are the requirements for a section.
RuleScope	scope()
java.util.Set<java.lang.String>	securityStandards()
java.lang.String	severity()
RuleStatus	status()
java.util.Set<java.lang.String>	tags()
boolean	template()
java.lang.String	toString()
RuleType	type()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

repository

public RulesDefinition.Repository repository()

Specified by:

repository in class RulesDefinition.Rule

pluginKey

@CheckForNull
public java.lang.String pluginKey()

Specified by:

pluginKey in class RulesDefinition.Rule

key

public java.lang.String key()

Specified by:

key in class RulesDefinition.Rule

name

public java.lang.String name()

Specified by:

name in class RulesDefinition.Rule

scope

public RuleScope scope()

Specified by:

scope in class RulesDefinition.Rule

type

public RuleType type()

Specified by:

type in class RulesDefinition.Rule

See Also:

RulesDefinition.NewRule.setType(RuleType)

cleanCodeAttribute

@CheckForNull
public CleanCodeAttribute cleanCodeAttribute()

Specified by:

cleanCodeAttribute in class RulesDefinition.Rule

See Also:

RulesDefinition.NewRule.setCleanCodeAttribute(CleanCodeAttribute)

severity

public java.lang.String severity()

Specified by:

severity in class RulesDefinition.Rule

defaultImpacts

public java.util.Map<SoftwareQuality,Severity> defaultImpacts()

Specified by:

defaultImpacts in class RulesDefinition.Rule

See Also:

RulesDefinition.NewRule.addDefaultImpact(SoftwareQuality, Severity)

ruleDescriptionSections

public java.util.List<RuleDescriptionSection> ruleDescriptionSections()

Description copied from class: RulesDefinition.Rule

See RulesDefinition.NewRule.addDescriptionSection(RuleDescriptionSection) to understand what are the requirements for a section.

Specified by:

ruleDescriptionSections in class RulesDefinition.Rule

educationPrincipleKeys

public java.util.Set<java.lang.String> educationPrincipleKeys()

Specified by:

educationPrincipleKeys in class RulesDefinition.Rule

htmlDescription

@CheckForNull
public java.lang.String htmlDescription()

Specified by:

htmlDescription in class RulesDefinition.Rule

markdownDescription

@CheckForNull
@Deprecated(since="9.6",
            forRemoval=true)
public java.lang.String markdownDescription()

Deprecated, for removal: This API element is subject to removal in a future version.

since 9.6 markdown support fur rule descriptions will be dropped

Specified by:

markdownDescription in class RulesDefinition.Rule

template

public boolean template()

Specified by:

template in class RulesDefinition.Rule

activatedByDefault

public boolean activatedByDefault()

Description copied from class: RulesDefinition.Rule

Should this rule be enabled by default. For example in SonarLint standalone.

Specified by:

activatedByDefault in class RulesDefinition.Rule

status

public RuleStatus status()

Specified by:

status in class RulesDefinition.Rule

debtRemediationFunction

@CheckForNull
public DebtRemediationFunction debtRemediationFunction()

Specified by:

debtRemediationFunction in class RulesDefinition.Rule

gapDescription

@CheckForNull
public java.lang.String gapDescription()

Specified by:

gapDescription in class RulesDefinition.Rule

param

@CheckForNull
public RulesDefinition.Param param(java.lang.String key)

Specified by:

param in class RulesDefinition.Rule

params

public java.util.List<RulesDefinition.Param> params()

Specified by:

params in class RulesDefinition.Rule

tags

public java.util.Set<java.lang.String> tags()

Specified by:

tags in class RulesDefinition.Rule

securityStandards

public java.util.Set<java.lang.String> securityStandards()

Specified by:

securityStandards in class RulesDefinition.Rule

deprecatedRuleKeys

public java.util.Set<RuleKey> deprecatedRuleKeys()

Description copied from class: RulesDefinition.Rule

Deprecated rules keys for this rule.

If you want to rename the key of a rule or change its repository or both, register the rule's previous repository and key (see addDeprecatedRuleKey). This will allow SonarQube to support "issue re-keying" for this rule.

If the repository and/or key of an existing rule is changed without declaring deprecated keys, existing issues for this rule, created under the rule's previous repository and/or key, will be closed and new ones will be created under the issue's new repository and/or key.

Several deprecated keys can be provided to allow SonarQube to support several key (and/or repository) changes across multiple versions of a plugin.
Consider the following use case scenario:

• Rule Foo:A is defined in version 1 of the plugin

   NewRepository newRepository = context.createRepository("Foo", "my_language");
   NewRule r = newRepository.createRule("A");
   

• Rule's key is renamed to B in version 2 of the plugin

   NewRepository newRepository = context.createRepository("Foo", "my_language");
   NewRule r = newRepository.createRule("B")
     .addDeprecatedRuleKey("Foo", "A");
   

• All rules, including Foo:B, are moved to a new repository Bar in version 3 of the plugin

   NewRepository newRepository = context.createRepository("Bar", "my_language");
   NewRule r = newRepository.createRule("B")
     .addDeprecatedRuleKey("Foo", "A")
     .addDeprecatedRuleKey("Bar", "B");
   

With all deprecated keys defined in version 3 of the plugin, SonarQube will be able to support "issue re-keying" for this rule in all cases:

• plugin upgrade from v1 to v2,
• plugin upgrade from v2 to v3
• AND plugin upgrade from v1 to v3

Finally, repository/key pairs must be unique across all rules and their deprecated keys.
This implies that no rule can use the same repository and key as the deprecated key of another rule. This uniqueness applies across plugins.

Note that, even though this method returns a Set, its elements are ordered according to calls to addDeprecatedRuleKey. This allows to describe the history of a rule's repositories and keys over time. Oldest repository and key must be specified first.

Specified by:

deprecatedRuleKeys in class RulesDefinition.Rule

See Also:

RulesDefinition.NewRule.addDeprecatedRuleKey(String, String)

internalKey

@CheckForNull
public java.lang.String internalKey()

Specified by:

internalKey in class RulesDefinition.Rule

See Also:

RulesDefinition.NewRule.setInternalKey(String)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object