org.sonar.api.server.rule

Class RulesDefinition.Rule

java.lang.Object

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

Enclosing interface:

RulesDefinition

@Immutable
public static class RulesDefinition.Rule
extends Object

Method Summary

Modifier and Type	Method and Description
boolean	activatedByDefault() Should this rule be enabled by default.
DebtRemediationFunction	debtRemediationFunction()
String	debtSubCharacteristic() Deprecated. in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. null is always returned. See https://jira.sonarsource.com/browse/MMF-184
String	effortToFixDescription() Deprecated. since 5.5, replaced by gapDescription()
boolean	equals(Object o)
String	gapDescription()
int	hashCode()
String	htmlDescription()
String	internalKey()
String	key()
String	markdownDescription()
String	name()
RulesDefinition.Param	param(String key)
List<RulesDefinition.Param>	params()
RulesDefinition.Repository	repository()
String	severity()
RuleStatus	status()
Set<String>	tags()
boolean	template()
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()

key

public String key()

name

public String name()

type

public RuleType type()

Since:

5.5

See Also:

RulesDefinition.NewRule.setType(RuleType)

severity

public String severity()

htmlDescription

@CheckForNull
public String htmlDescription()

markdownDescription

@CheckForNull
public String markdownDescription()

template

public boolean template()

activatedByDefault

public boolean activatedByDefault()

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

Since:

6.0

status

public RuleStatus status()

debtSubCharacteristic

@CheckForNull
 @Deprecated
public String debtSubCharacteristic()

Deprecated. in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. null is always returned. See https://jira.sonarsource.com/browse/MMF-184

See Also:

type()

debtRemediationFunction

@CheckForNull
public DebtRemediationFunction debtRemediationFunction()

effortToFixDescription

@Deprecated
 @CheckForNull
public String effortToFixDescription()

Deprecated. since 5.5, replaced by gapDescription()

gapDescription

@CheckForNull
public String gapDescription()

param

@CheckForNull
public RulesDefinition.Param param(String key)

params

public List<RulesDefinition.Param> params()

tags

public Set<String> tags()

internalKey

@CheckForNull
public String internalKey()

See Also:

RulesDefinition.NewRule.setInternalKey(String)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object