public class Rule
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static RulePriority |
DEFAULT_PRIORITY
The default priority given to a rule if not explicitly set
|
static java.lang.String |
STATUS_BETA |
static java.lang.String |
STATUS_DEPRECATED |
static java.lang.String |
STATUS_READY |
static java.lang.String |
STATUS_REMOVED
For internal use only.
|
Constructor and Description |
---|
Rule()
Deprecated.
since 2.3. Use the factory method
create() |
Rule(java.lang.String pluginName,
java.lang.String key)
Deprecated.
since 2.3. Use the factory method
create() |
Modifier and Type | Method and Description |
---|---|
static Rule |
create() |
static Rule |
create(java.lang.String repositoryKey,
java.lang.String key)
Create with all required fields
|
static Rule |
create(java.lang.String repositoryKey,
java.lang.String key,
java.lang.String name)
Create with all required fields
|
RuleParam |
createParameter() |
RuleParam |
createParameter(java.lang.String key) |
boolean |
equals(java.lang.Object obj) |
org.sonar.check.Cardinality |
getCardinality()
Deprecated.
since 4.4, use
isTemplate() |
java.lang.Integer |
getCharacteristicId()
Deprecated.
since 4.4, use
getCharacteristicKey() |
java.lang.String |
getCharacteristicKey()
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
java.lang.String |
getConfigKey() |
java.util.Date |
getCreatedAt() |
java.lang.Integer |
getDefaultCharacteristicId()
Deprecated.
since 4.4, use
getDefaultCharacteristicKey() |
java.lang.String |
getDefaultCharacteristicKey()
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
java.lang.String |
getDefaultSubCharacteristicKey()
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
java.lang.String |
getDescription() |
java.lang.Integer |
getId() |
java.lang.String |
getKey() |
java.lang.String |
getLanguage() |
java.lang.String |
getName() |
RuleParam |
getParam(java.lang.String key) |
java.util.List<RuleParam> |
getParams() |
Rule |
getParent()
Deprecated.
since 4.4, use
getTemplate() |
java.lang.String |
getRepositoryKey() |
RulePriority |
getSeverity() |
java.lang.String |
getStatus() |
java.lang.String |
getSubCharacteristicKey()
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
java.lang.String[] |
getSystemTags()
For internal use
|
java.lang.String[] |
getTags()
For definition of rule only
|
Rule |
getTemplate() |
java.util.Date |
getUpdatedAt() |
int |
hashCode() |
java.lang.Boolean |
isEnabled() |
boolean |
isTemplate() |
RuleKey |
ruleKey() |
Rule |
setCardinality(org.sonar.check.Cardinality c)
Deprecated.
since 4.4, use
setIsTemplate(boolean) |
Rule |
setCharacteristicId(java.lang.Integer characteristicId)
Deprecated.
since 4.4, use
setCharacteristicKey(String) |
Rule |
setCharacteristicKey(java.lang.String characteristicKey)
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
Rule |
setConfigKey(java.lang.String configKey)
Sets the configuration key
|
Rule |
setCreatedAt(java.util.Date d) |
Rule |
setDefaultCharacteristicId(java.lang.Integer defaultCharacteristicId)
Deprecated.
since 4.4, use
setDefaultCharacteristicKey(String) |
Rule |
setDefaultCharacteristicKey(java.lang.String defaultCharacteristicKey)
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
Rule |
setDefaultSubCharacteristicKey(java.lang.String defaultSubCharacteristicKey)
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
Rule |
setDescription(java.lang.String description)
Sets the rule description
|
void |
setId(java.lang.Integer id)
Deprecated.
since 2.3. visibility should be decreased to protected or package
|
Rule |
setIsTemplate(boolean isTemplate) |
Rule |
setKey(java.lang.String key)
Sets the rule key
|
Rule |
setLanguage(java.lang.String language)
For internal use only.
|
Rule |
setName(java.lang.String name)
Sets the rule name
|
Rule |
setParams(java.util.List<RuleParam> params)
Sets the rule parameters
|
Rule |
setParent(Rule parent)
Deprecated.
since 4.4, use
setTemplate(Rule) } |
Rule |
setRepositoryKey(java.lang.String s) |
Rule |
setSeverity(RulePriority severity) |
Rule |
setStatus(java.lang.String status) |
Rule |
setSubCharacteristicKey(java.lang.String subCharacteristicKey)
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model.
|
Rule |
setSystemTags(java.lang.String[] tags) |
Rule |
setTags(java.lang.String[] tags)
For definition of rule only
|
Rule |
setTemplate(Rule template) |
Rule |
setUniqueKey(java.lang.String repositoryKey,
java.lang.String key) |
Rule |
setUpdatedAt(java.util.Date updatedAt) |
java.lang.String |
toString() |
public static final java.lang.String STATUS_BETA
public static final java.lang.String STATUS_DEPRECATED
public static final java.lang.String STATUS_READY
public static final java.lang.String STATUS_REMOVED
public static final RulePriority DEFAULT_PRIORITY
@Deprecated public Rule()
create()
@Deprecated public Rule(java.lang.String pluginName, java.lang.String key)
create()
pluginName
- the plugin name indicates which plugin the rule belongs tokey
- the key should be unique within a plugin, but it is even more careful for the time being that it is unique across the
applicationpublic java.lang.Integer getId()
@Deprecated public void setId(java.lang.Integer id)
public java.lang.String getName()
public Rule setName(java.lang.String name)
public java.lang.String getKey()
public Rule setKey(java.lang.String key)
public java.lang.String getConfigKey()
public Rule setConfigKey(java.lang.String configKey)
public java.lang.String getDescription()
public Rule setDescription(java.lang.String description)
public java.lang.Boolean isEnabled()
public java.util.List<RuleParam> getParams()
public RuleParam getParam(java.lang.String key)
public RuleParam createParameter()
public RuleParam createParameter(java.lang.String key)
public RulePriority getSeverity()
public Rule setSeverity(RulePriority severity)
severity
- severity to set, if null, uses the default priority.public java.lang.String getRepositoryKey()
public Rule setRepositoryKey(java.lang.String s)
public Rule setUniqueKey(java.lang.String repositoryKey, java.lang.String key)
public boolean isTemplate()
public Rule setIsTemplate(boolean isTemplate)
@Deprecated public org.sonar.check.Cardinality getCardinality()
isTemplate()
@Deprecated public Rule setCardinality(org.sonar.check.Cardinality c)
setIsTemplate(boolean)
@Deprecated public Rule getParent()
getTemplate()
@Deprecated public Rule setParent(Rule parent)
setTemplate(Rule)
}public Rule getTemplate()
public java.lang.String getStatus()
public Rule setStatus(java.lang.String status)
public java.util.Date getCreatedAt()
public Rule setCreatedAt(java.util.Date d)
public java.util.Date getUpdatedAt()
public Rule setUpdatedAt(java.util.Date updatedAt)
public java.lang.String getLanguage()
public Rule setLanguage(java.lang.String language)
public java.lang.String[] getTags()
public Rule setTags(java.lang.String[] tags)
public java.lang.String[] getSystemTags()
public Rule setSystemTags(java.lang.String[] tags)
@CheckForNull @Deprecated public java.lang.Integer getCharacteristicId()
getCharacteristicKey()
@Deprecated public Rule setCharacteristicId(@Nullable java.lang.Integer characteristicId)
setCharacteristicKey(String)
@CheckForNull @Deprecated public java.lang.Integer getDefaultCharacteristicId()
getDefaultCharacteristicKey()
@Deprecated public Rule setDefaultCharacteristicId(@Nullable java.lang.Integer defaultCharacteristicId)
setDefaultCharacteristicKey(String)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static Rule create()
public static Rule create(java.lang.String repositoryKey, java.lang.String key, java.lang.String name)
public static Rule create(java.lang.String repositoryKey, java.lang.String key)
public RuleKey ruleKey()
@CheckForNull @Deprecated public java.lang.String getDefaultCharacteristicKey()
@Deprecated public Rule setDefaultCharacteristicKey(@Nullable java.lang.String defaultCharacteristicKey)
@CheckForNull @Deprecated public java.lang.String getDefaultSubCharacteristicKey()
@Deprecated public Rule setDefaultSubCharacteristicKey(@Nullable java.lang.String defaultSubCharacteristicKey)
@CheckForNull @Deprecated public java.lang.String getCharacteristicKey()
@Deprecated public Rule setCharacteristicKey(@Nullable java.lang.String characteristicKey)
@CheckForNull @Deprecated public java.lang.String getSubCharacteristicKey()
@Deprecated public Rule setSubCharacteristicKey(@Nullable java.lang.String subCharacteristicKey)