Deprecate Rule.setPluginName() , Rule.getPluginName() and related stuff, because...

diff --git a/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/sensors/ViolationsDecoratorTest.java b/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/sensors/ViolationsDecoratorTest.java
index 1abffdfb8f3fb625df60b28196cd90f0438eaf7a..6670ae97e41c144b422f15eeade3d6ba86c74503 100644 (file)
--- a/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/sensors/ViolationsDecoratorTest.java
+++ b/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/sensors/ViolationsDecoratorTest.java
@@ -50,9 +50,9 @@ public class ViolationsDecoratorTest {
 
   @Before
   public void before() {
-    ruleA1 = Rule.create().setPluginName("ruleA1").setKey("ruleA1").setName("nameA1");
-    ruleA2 = Rule.create().setPluginName("ruleA2").setKey("ruleA2").setName("nameA2");
-    ruleB1 = Rule.create().setPluginName("ruleB1").setKey("ruleB1").setName("nameB1");
+    ruleA1 = Rule.create().setRepositoryKey("ruleA1").setKey("ruleA1").setName("nameA1");
+    ruleA2 = Rule.create().setRepositoryKey("ruleA2").setKey("ruleA2").setName("nameA2");
+    ruleB1 = Rule.create().setRepositoryKey("ruleB1").setKey("ruleB1").setName("nameB1");
 
     decorator = new ViolationsDecorator();
     resource = mock(Resource.class);

diff --git a/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/timemachine/NewViolationsDecoratorTest.java b/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/timemachine/NewViolationsDecoratorTest.java
index 84bd2b100ebbb640174fbc933dff03d9266b3a63..34e6963a642abcd9c8b075a8038c13dd55d2cfb6 100644 (file)
--- a/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/timemachine/NewViolationsDecoratorTest.java
+++ b/plugins/sonar-core-plugin/src/test/java/org/sonar/plugins/core/timemachine/NewViolationsDecoratorTest.java
@@ -82,9 +82,9 @@ public class NewViolationsDecoratorTest {
 
     decorator = new NewViolationsDecorator(timeMachineConfiguration);
 
-    rule1 = Rule.create().setPluginName("rule1").setKey("rule1").setName("name1");
-    rule2 = Rule.create().setPluginName("rule2").setKey("rule2").setName("name2");
-    rule3 = Rule.create().setPluginName("rule3").setKey("rule3").setName("name3");
+    rule1 = Rule.create().setRepositoryKey("rule1").setKey("rule1").setName("name1");
+    rule2 = Rule.create().setRepositoryKey("rule2").setKey("rule2").setName("name2");
+    rule3 = Rule.create().setRepositoryKey("rule3").setKey("rule3").setName("name3");
   }
 
   @Test

diff --git a/sonar-core/src/main/java/org/sonar/jpa/dao/RulesDao.java b/sonar-core/src/main/java/org/sonar/jpa/dao/RulesDao.java
index 736d977ac302f3aa6bd5730d15a03aebf8c79d08..8cb5151c7f59359d5f58ebd51923115739b03461 100644 (file)
--- a/sonar-core/src/main/java/org/sonar/jpa/dao/RulesDao.java
+++ b/sonar-core/src/main/java/org/sonar/jpa/dao/RulesDao.java
@@ -41,13 +41,20 @@ public class RulesDao extends BaseDao {
     return getSession().getResults(Rule.class, "enabled", true);\r
   }\r
 \r
-  public List<Rule> getRulesByPlugin(String pluginKey) {\r
-    return getSession().getResults(Rule.class, "pluginName", pluginKey, "enabled", true);\r
+  public List<Rule> getRulesByRepository(String repositoryKey) {\r
+    return getSession().getResults(Rule.class, "pluginName", repositoryKey, "enabled", true);\r
   }\r
 \r
+  /**\r
+   * @deprecated since 2.5 use {@link #getRulesByRepository(String)} instead.\r
+   */\r
+  @Deprecated\r
+  public List<Rule> getRulesByPlugin(String pluginKey) {\r
+    return getRulesByRepository(pluginKey);\r
+  }\r
 \r
-  public Rule getRuleByKey(String pluginKey, String ruleKey) {\r
-    return getSession().getSingleResult(Rule.class, "key", ruleKey, "pluginName", pluginKey, "enabled", true);\r
+  public Rule getRuleByKey(String repositoryKey, String ruleKey) {\r
+    return getSession().getSingleResult(Rule.class, "key", ruleKey, "pluginName", repositoryKey, "enabled", true);\r
   }\r
 \r
   public Long countRules(List<String> plugins) {\r
@@ -57,7 +64,6 @@ public class RulesDao extends BaseDao {
         getSingleResult();\r
   }\r
 \r
-\r
   public List<RuleParam> getRuleParams() {\r
     return getSession().getResults(RuleParam.class);\r
   }\r

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java b/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java
index 01d91243bbb2b9304daf7ff99b0bfcb30f0c8883..895bea88ebac19a030dc62813e42881d49886678 100644 (file)
--- a/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/profiles/RulesProfile.java
@@ -29,14 +29,13 @@ import org.sonar.api.rules.ActiveRule;
 import org.sonar.api.rules.Rule;
 import org.sonar.api.rules.RulePriority;
 
-import javax.persistence.*;
-
 import java.util.ArrayList;
 import java.util.List;
 
+import javax.persistence.*;
+
 /**
- * This class is badly named. It should be "QualityProfile". Indeed it does not relate only to rules but to metric
- * thresholds too.
+ * This class is badly named. It should be "QualityProfile". Indeed it does not relate only to rules but to metric thresholds too.
  */
 @Entity
 @Table(name = "rules_profiles")
@@ -153,16 +152,16 @@ public class RulesProfile implements Cloneable {
   }
 
   /**
-   * Set whether this is the default profile for the language. The default profile is used when none is explicitly
-   * defined when auditing a project.
+   * Set whether this is the default profile for the language. The default profile is used when none is explicitly defined when auditing a
+   * project.
    */
   public void setDefaultProfile(Boolean b) {
     this.defaultProfile = b;
   }
 
   /**
-   * @return whether the profile is defined in a plugin. Provided profiles are automatically restored during
-   *         server startup and can not be updated by end users.
+   * @return whether the profile is defined in a plugin. Provided profiles are automatically restored during server startup and can not be
+   *         updated by end users.
    */
   public Boolean getProvided() {
     return provided;
@@ -232,7 +231,7 @@ public class RulesProfile implements Cloneable {
   }
 
   /**
-   * @deprecated since 2.3. Use getActiveRulesByRepository().
+   * @deprecated since 2.3 use {@link #getActiveRulesByRepository()} instead.
    */
   @Deprecated
   public List<ActiveRule> getActiveRulesByPlugin(String repositoryKey) {
@@ -242,7 +241,7 @@ public class RulesProfile implements Cloneable {
   public List<ActiveRule> getActiveRulesByRepository(String repositoryKey) {
     List<ActiveRule> result = new ArrayList<ActiveRule>();
     for (ActiveRule activeRule : getActiveRules()) {
-      if (repositoryKey.equals(activeRule.getPluginName())) {
+      if (repositoryKey.equals(activeRule.getRepositoryKey())) {
         result.add(activeRule);
       }
     }

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/rules/ActiveRule.java b/sonar-plugin-api/src/main/java/org/sonar/api/rules/ActiveRule.java
index a57bc3c21bb01573c17dc0ba4eeca79ded59b214..de5db8d61a8ee8cf03bd34ef85e893ea56885c03 100644 (file)
--- a/sonar-plugin-api/src/main/java/org/sonar/api/rules/ActiveRule.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/rules/ActiveRule.java
@@ -25,11 +25,11 @@ import org.apache.commons.lang.StringUtils;
 import org.apache.commons.lang.builder.ToStringBuilder;
 import org.sonar.api.profiles.RulesProfile;
 
-import javax.persistence.*;
-
 import java.util.ArrayList;
 import java.util.List;
 
+import javax.persistence.*;
+
 /**
  * A class to map an ActiveRule to the hibernate model
  */
@@ -175,11 +175,11 @@ public class ActiveRule implements Cloneable {
   }
 
   /**
-   * @deprecated use getRepositoryKey()
+   * @deprecated since 2.3 use {@link #getRepositoryKey()} instead
    */
   @Deprecated
   public String getPluginName() {
-    return rule.getPluginName();
+    return rule.getRepositoryKey();
   }
 
   public String getRepositoryKey() {
@@ -230,7 +230,8 @@ public class ActiveRule implements Cloneable {
 
   @Override
   public String toString() {
-    return new ToStringBuilder(this).append("id", getId()).append("rule", rule).append("priority", severity).append("params", activeRuleParams).toString();
+    return new ToStringBuilder(this).append("id", getId()).append("rule", rule).append("priority", severity)
+        .append("params", activeRuleParams).toString();
   }
 
   @Override

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/rules/Rule.java b/sonar-plugin-api/src/main/java/org/sonar/api/rules/Rule.java
index 618d0e6fb4695cffc7f1cfac3a3327c306e048e2..6a33cb6c5f6f98bb5b4f765a2a1d8574d67ddd42 100644 (file)
--- a/sonar-plugin-api/src/main/java/org/sonar/api/rules/Rule.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/rules/Rule.java
@@ -26,11 +26,11 @@ import org.apache.commons.lang.builder.ToStringBuilder;
 import org.sonar.api.database.DatabaseProperties;\r
 import org.sonar.check.Cardinality;\r
 \r
-import javax.persistence.*;\r
-\r
 import java.util.ArrayList;\r
 import java.util.List;\r
 \r
+import javax.persistence.*;\r
+\r
 @Entity\r
 @Table(name = "rules")\r
 public final class Rule {\r
@@ -92,8 +92,8 @@ public final class Rule {
    * Creates rule with minimum set of info\r
    * \r
    * @param pluginName the plugin name indicates which plugin the rule belongs to\r
-   * @param key the key should be unique within a plugin, but it is even more careful for the time being that it is unique\r
-   *          across the application\r
+   * @param key the key should be unique within a plugin, but it is even more careful for the time being that it is unique across the\r
+   *          application\r
    * @deprecated since 2.3. Use the factory method {@link #create()}\r
    */\r
   @Deprecated\r
@@ -107,8 +107,8 @@ public final class Rule {
    * Creates a fully qualified rule\r
    * \r
    * @param pluginKey the plugin the rule belongs to\r
-   * @param key the key should be unique within a plugin, but it is even more careful for the time being that it is unique\r
-   *          across the application\r
+   * @param key the key should be unique within a plugin, but it is even more careful for the time being that it is unique across the\r
+   *          application\r
    * @param name the name displayed in the UI\r
    * @param rulesCategory the ISO category the rule belongs to\r
    * @param severity this is the severity associated to the rule\r
@@ -201,13 +201,18 @@ public final class Rule {
     return this;\r
   }\r
 \r
+  /**\r
+   * @deprecated since 2.5 use {@link #getRepositoryKey()} instead\r
+   */\r
+  @Deprecated\r
   public String getPluginName() {\r
     return pluginName;\r
   }\r
 \r
   /**\r
-   * Sets the plugin name the rule belongs to\r
+   * @deprecated since 2.5 use {@link #setRepositoryKey(String)} instead\r
    */\r
+  @Deprecated\r
   public Rule setPluginName(String pluginName) {\r
     this.pluginName = pluginName;\r
     return this;\r
@@ -229,6 +234,14 @@ public final class Rule {
     return description;\r
   }\r
 \r
+  /**\r
+   * Sets the rule description\r
+   */\r
+  public Rule setDescription(String description) {\r
+    this.description = StringUtils.strip(description);\r
+    return this;\r
+  }\r
+\r
   public Boolean isEnabled() {\r
     return enabled;\r
   }\r
@@ -241,14 +254,6 @@ public final class Rule {
     return this;\r
   }\r
 \r
-  /**\r
-   * Sets the rule description\r
-   */\r
-  public Rule setDescription(String description) {\r
-    this.description = StringUtils.strip(description);\r
-    return this;\r
-  }\r
-\r
   public List<RuleParam> getParams() {\r
     return params;\r
   }\r
@@ -276,15 +281,15 @@ public final class Rule {
 \r
   public RuleParam createParameter() {\r
     RuleParam parameter = new RuleParam()\r
-      .setRule(this);\r
+        .setRule(this);\r
     params.add(parameter);\r
     return parameter;\r
   }\r
 \r
   public RuleParam createParameter(String key) {\r
     RuleParam parameter = new RuleParam()\r
-      .setKey(key)\r
-      .setRule(this);\r
+        .setKey(key)\r
+        .setRule(this);\r
     params.add(parameter);\r
     return parameter;\r
   }\r
@@ -376,7 +381,7 @@ public final class Rule {
     }\r
     Rule other = (Rule) obj;\r
     return new EqualsBuilder()\r
-        .append(pluginName, other.getPluginName())\r
+        .append(pluginName, other.getRepositoryKey())\r
         .append(key, other.getKey())\r
         .isEquals();\r
   }\r