org.sonar.api.profiles

Class RulesProfile

java.lang.Object

org.sonar.api.profiles.RulesProfile

All Implemented Interfaces:

Cloneable

public class RulesProfile
extends Object
implements Cloneable

This class is badly named. It should be "QualityProfile". Indeed it does not relate only to rules but to metric thresholds too.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SONAR_WAY_FINDBUGS_NAME Deprecated. in 4.2. Use your own constant.
static String	SONAR_WAY_NAME Deprecated. in 4.2. Use your own constant.
static String	SUN_CONVENTIONS_NAME Deprecated. in 4.2. Use your own constant.

Constructor Summary

Constructors

Constructor and Description
RulesProfile() Deprecated. use the factory method create()
RulesProfile(String name, String language) Deprecated. since 2.3. Use the factory method create()
RulesProfile(String name, String language, boolean defaultProfile, boolean provided) Deprecated. since 2.3. Use the factory method create()

Method Summary

Modifier and Type	Method and Description
ActiveRule	activateRule(Rule rule, RulePriority optionalSeverity)
RulesProfile	addActiveRule(ActiveRule activeRule)
Object	clone()
static RulesProfile	create()
static RulesProfile	create(String name, String language)
boolean	equals(Object obj)
ActiveRule	getActiveRule(Rule rule) Note: disabled rules are excluded.
ActiveRule	getActiveRule(String repositoryKey, String ruleKey) Note: disabled rules are excluded.
ActiveRule	getActiveRuleByConfigKey(String repositoryKey, String configKey) Note: disabled rules are excluded.
List<ActiveRule>	getActiveRules()
List<ActiveRule>	getActiveRules(boolean acceptDisabledRules)
List<ActiveRule>	getActiveRules(RulePriority severity) Note: disabled rules are excluded.
List<ActiveRule>	getActiveRulesByRepository(String repositoryKey) Get the active rules of a specific repository.
Boolean	getDefaultProfile()
Integer	getId()
String	getLanguage()
String	getName()
String	getParentName() For internal use only.
Boolean	getUsed() Deprecated. profile versioning is dropped in 4.4. Always returns null.
int	getVersion() Deprecated. profile versioning is dropped in 4.4. Always returns -1.
int	hashCode()
RulesProfile	removeActiveRule(ActiveRule activeRule)
void	setActiveRules(List<ActiveRule> activeRules) Set the list of active rules
void	setDefaultProfile(Boolean b) Set whether this is the default profile for the language.
RulesProfile	setLanguage(String s) Set the profile language
RulesProfile	setName(String s) Set the profile name.
void	setParentName(String parentName) For internal use only.
RulesProfile	setUsed(Boolean used) Deprecated. profile versioning is dropped in 4.4. Always returns -1.
RulesProfile	setVersion(int version) Deprecated. profile versioning is dropped in 4.4. Always returns -1.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SONAR_WAY_NAME

@Deprecated
public static final String SONAR_WAY_NAME

Deprecated. in 4.2. Use your own constant.

Name of the default profile "Sonar Way"

See Also:

Constant Field Values

SONAR_WAY_FINDBUGS_NAME

@Deprecated
public static final String SONAR_WAY_FINDBUGS_NAME

Deprecated. in 4.2. Use your own constant.

Name of the default java profile "Sonar way with Findbugs"

See Also:

Constant Field Values

SUN_CONVENTIONS_NAME

@Deprecated
public static final String SUN_CONVENTIONS_NAME

Deprecated. in 4.2. Use your own constant.

Name of the default java profile "Sun checks"

See Also:

Constant Field Values

Constructor Detail

RulesProfile

@Deprecated
public RulesProfile()

Deprecated. use the factory method create()

RulesProfile

@Deprecated
public RulesProfile(String name,
                                String language)

Deprecated. since 2.3. Use the factory method create()

RulesProfile

@Deprecated
public RulesProfile(String name,
                                String language,
                                boolean defaultProfile,
                                boolean provided)

Deprecated. since 2.3. Use the factory method create()

Method Detail

getId

public Integer getId()

getName

public String getName()

Returns:

the profile name, unique by language.

setName

public RulesProfile setName(String s)

Set the profile name.

getVersion

@Deprecated
public int getVersion()

Deprecated. profile versioning is dropped in 4.4. Always returns -1.

setVersion

@Deprecated
public RulesProfile setVersion(int version)

Deprecated. profile versioning is dropped in 4.4. Always returns -1.

getUsed

@CheckForNull
 @Deprecated
public Boolean getUsed()

Deprecated. profile versioning is dropped in 4.4. Always returns null.

setUsed

@Deprecated
public RulesProfile setUsed(Boolean used)

Deprecated. profile versioning is dropped in 4.4. Always returns -1.

getActiveRules

public List<ActiveRule> getActiveRules()

Returns:

the list of active rules

getActiveRules

public List<ActiveRule> getActiveRules(boolean acceptDisabledRules)

Returns:

the list of active rules

removeActiveRule

public RulesProfile removeActiveRule(ActiveRule activeRule)

addActiveRule

public RulesProfile addActiveRule(ActiveRule activeRule)

setActiveRules

public void setActiveRules(List<ActiveRule> activeRules)

Set the list of active rules

getDefaultProfile

public Boolean getDefaultProfile()

Returns:

whether this is the default profile for the language

setDefaultProfile

public void setDefaultProfile(Boolean b)

Set whether this is the default profile for the language. The default profile is used when none is explicitly defined when auditing a project.

getLanguage

public String getLanguage()

Returns:

the profile language

setLanguage

public RulesProfile setLanguage(String s)

Set the profile language

getParentName

@CheckForNull
public String getParentName()

For internal use only.

Since:

2.5

setParentName

public void setParentName(String parentName)

For internal use only.

Since:

2.5

getActiveRules

public List<ActiveRule> getActiveRules(RulePriority severity)

Note: disabled rules are excluded.

Returns:

the list of active rules for a given severity

getActiveRulesByRepository

public List<ActiveRule> getActiveRulesByRepository(String repositoryKey)

Get the active rules of a specific repository. Only enabled rules are selected. Disabled rules are excluded.

getActiveRule

@CheckForNull
public ActiveRule getActiveRule(String repositoryKey,
                                              String ruleKey)

Note: disabled rules are excluded.

Returns:

an active rule from a plugin key and a rule key if the rule is activated, null otherwise

getActiveRuleByConfigKey

@CheckForNull
public ActiveRule getActiveRuleByConfigKey(String repositoryKey,
                                                         String configKey)

Note: disabled rules are excluded.

getActiveRule

@CheckForNull
public ActiveRule getActiveRule(Rule rule)

Note: disabled rules are excluded.

activateRule

public ActiveRule activateRule(Rule rule,
                               @Nullable
                               RulePriority optionalSeverity)

Parameters:

optionalSeverity - if null, then the default rule severity is used

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object

create

public static RulesProfile create(String name,
                                  String language)

create

public static RulesProfile create()