|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.sonar.api.database.BaseIdentifiable org.sonar.api.rules.Rule
public class Rule
A class to map rules with Hibernate model
Field Summary | |
---|---|
static RulePriority |
DEFAULT_PRIORITY
The default priority given to a rule if not explicitely set |
Constructor Summary | |
---|---|
Rule()
|
|
Rule(String pluginName,
String key)
Creates rule with minimum set of info |
|
Rule(String name,
String key,
RulesCategory rulesCategory,
String pluginName,
String description)
Deprecated. |
|
Rule(String pluginKey,
String key,
String name,
RulesCategory rulesCategory,
RulePriority priority)
Creates a fully qualified rule |
|
Rule(String name,
String key,
String configKey,
RulesCategory rulesCategory,
String pluginName,
String description)
Deprecated. |
Method Summary | |
---|---|
boolean |
equals(Object obj)
|
Integer |
getCategoryId()
|
String |
getConfigKey()
|
String |
getDescription()
|
String |
getKey()
|
String |
getName()
|
List<RuleParam> |
getParams()
|
String |
getPluginName()
|
RulePriority |
getPriority()
|
RulesCategory |
getRulesCategory()
|
int |
hashCode()
|
Rule |
setConfigKey(String configKey)
Sets the configuration key |
Rule |
setDescription(String description)
Sets the rule description |
Rule |
setKey(String key)
Sets the rule key |
Rule |
setName(String name)
Sets the rule name |
Rule |
setParams(List<RuleParam> params)
Sets the rule parameters |
Rule |
setPluginName(String pluginName)
Sets the plugin name the rule belongs to |
Rule |
setPriority(RulePriority priority)
Sets the rule priority. |
Rule |
setRulesCategory(RulesCategory rulesCategory)
Sets the rule category |
String |
toString()
|
Methods inherited from class org.sonar.api.database.BaseIdentifiable |
---|
getId, setId |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final RulePriority DEFAULT_PRIORITY
Constructor Detail |
---|
public Rule()
public Rule(String pluginName, String key)
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 Rule(String pluginKey, String key, String name, RulesCategory rulesCategory, RulePriority priority)
pluginKey
- the 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 applicationname
- the name displayed in the UIrulesCategory
- the ISO category the rule belongs topriority
- this is the priority associated to the rule@Deprecated public Rule(String name, String key, RulesCategory rulesCategory, String pluginName, String description)
@Deprecated public Rule(String name, String key, String configKey, RulesCategory rulesCategory, String pluginName, String description)
Method Detail |
---|
public String getName()
public final Rule setName(String name)
public String getKey()
public Rule setKey(String key)
public RulesCategory getRulesCategory()
public Rule setRulesCategory(RulesCategory rulesCategory)
public String getPluginName()
public Rule setPluginName(String pluginName)
public String getConfigKey()
public Rule setConfigKey(String configKey)
public String getDescription()
public Rule setDescription(String description)
public List<RuleParam> getParams()
public Rule setParams(List<RuleParam> params)
public Integer getCategoryId()
public RulePriority getPriority()
public Rule setPriority(RulePriority priority)
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |