org.sonar.api.rules

Class ActiveRule

java.lang.Object

org.sonar.api.rules.ActiveRule

All Implemented Interfaces:

Cloneable

public class ActiveRule
extends Object
implements Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
static String	INHERITED
static String	OVERRIDES

Constructor Summary

Constructors

Constructor and Description
ActiveRule() Deprecated. visibility should be reduced to protected or package
ActiveRule(RulesProfile profile, Rule rule, RulePriority severity) Deprecated. visibility should be reduced to protected or package

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	doesOverride()
boolean	equals(Object o)
List<ActiveRuleParam>	getActiveRuleParams()
String	getConfigKey()
Integer	getId()
String	getInheritance() For internal use only.
Date	getNoteCreatedAt() Deprecated. in 4.4. Feature dropped.
String	getNoteData() Deprecated. in 4.4. Feature dropped.
Date	getNoteUpdatedAt() Deprecated. in 4.4. Feature dropped.
String	getNoteUserLogin() Deprecated. in 4.4. Feature dropped.
String	getParameter(String key)
String	getPluginName() Deprecated. since 2.3 use getRepositoryKey() instead
RulePriority	getPriority() Deprecated. since 2.5 use getSeverity() instead. See http://jira.sonarsource.com/browse/SONAR-1829
String	getRepositoryKey()
Rule	getRule()
String	getRuleKey()
RulesProfile	getRulesProfile()
RulePriority	getSeverity()
int	hashCode()
boolean	isEnabled()
boolean	isInherited()
void	setActiveRuleParams(List<ActiveRuleParam> params) Deprecated. use setParameter()
void	setId(Integer id) Deprecated. visibility should be decreased to protected or package
void	setInheritance(String s) For internal use only.
ActiveRule	setParameter(String key, String value)
void	setPriority(RulePriority priority) Deprecated. since 2.5 use setSeverity(RulePriority) instead. See http://jira.sonarsource.com/browse/SONAR-1829
void	setRule(Rule rule) Deprecated. visibility should be reduced to protected or package
void	setRulesProfile(RulesProfile rulesProfile) Deprecated. visibility should be reduced to protected or package
void	setSeverity(RulePriority severity)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INHERITED

public static final String INHERITED

See Also:

Constant Field Values

OVERRIDES

public static final String OVERRIDES

See Also:

Constant Field Values

Constructor Detail

ActiveRule

@Deprecated
public ActiveRule()

Deprecated. visibility should be reduced to protected or package

ActiveRule

@Deprecated
public ActiveRule(RulesProfile profile,
                              Rule rule,
                              RulePriority severity)

Deprecated. visibility should be reduced to protected or package

Method Detail

getId

public Integer getId()

getInheritance

public String getInheritance()

For internal use only.

Since:

2.5

setInheritance

public void setInheritance(String s)

For internal use only.

Since:

2.5

isInherited

public boolean isInherited()

doesOverride

public boolean doesOverride()

setId

@Deprecated
public void setId(Integer id)

Deprecated. visibility should be decreased to protected or package

getRule

public Rule getRule()

setRule

@Deprecated
public void setRule(Rule rule)

Deprecated. visibility should be reduced to protected or package

getSeverity

public RulePriority getSeverity()

Since:

2.5

setSeverity

public void setSeverity(RulePriority severity)

Since:

2.5

getPriority

@Deprecated
public RulePriority getPriority()

Deprecated. since 2.5 use getSeverity() instead. See http://jira.sonarsource.com/browse/SONAR-1829

setPriority

@Deprecated
public void setPriority(RulePriority priority)

Deprecated. since 2.5 use setSeverity(RulePriority) instead. See http://jira.sonarsource.com/browse/SONAR-1829

getRulesProfile

public RulesProfile getRulesProfile()

setRulesProfile

@Deprecated
public void setRulesProfile(RulesProfile rulesProfile)

Deprecated. visibility should be reduced to protected or package

getActiveRuleParams

public List<ActiveRuleParam> getActiveRuleParams()

setActiveRuleParams

@Deprecated
public void setActiveRuleParams(List<ActiveRuleParam> params)

Deprecated. use setParameter()

setParameter

public ActiveRule setParameter(String key,
                               String value)

getParameter

public String getParameter(String key)

getPluginName

@Deprecated
public String getPluginName()

Deprecated. since 2.3 use getRepositoryKey() instead

getRepositoryKey

public String getRepositoryKey()

getConfigKey

public String getConfigKey()

Returns:

the config key the active rule belongs to

getRuleKey

public String getRuleKey()

Returns:

the key of the active rule

getNoteData

@CheckForNull
 @Deprecated
public String getNoteData()

Deprecated. in 4.4. Feature dropped.

Since:

4.2

getNoteUserLogin

@CheckForNull
 @Deprecated
public String getNoteUserLogin()

Deprecated. in 4.4. Feature dropped.

Since:

4.2

getNoteCreatedAt

@CheckForNull
 @Deprecated
public Date getNoteCreatedAt()

Deprecated. in 4.4. Feature dropped.

Since:

4.2

getNoteUpdatedAt

@CheckForNull
 @Deprecated
public Date getNoteUpdatedAt()

Deprecated. in 4.4. Feature dropped.

Since:

4.2

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

clone

public Object clone()

Overrides:

clone in class Object

isEnabled

public boolean isEnabled()

Since:

2.6