From e9c4b0cddfdd40f761a4385822afaec0a4d13075 Mon Sep 17 00:00:00 2001
From: Pavel Dolgov <pavel.dolgov@jetbrains.com>
Date: Mon, 8 Aug 2016 17:41:24 +0300
Subject: [PATCH] Java inspection: Rename the inspection to a noun-based name,
 update documentation (IDEA-157727)

---
 .../src/META-INF/InspectionGadgets.xml                   | 6 +++---
 .../src/com/siyeh/InspectionGadgetsBundle.properties     | 6 +++---
 ...ction.java => SingleElementAnnotationInspection.java} | 9 ++++-----
 .../inspectionDescriptions/ExpandToNormalAnnotation.html | 6 ------
 .../inspectionDescriptions/SingleElementAnnotation.html  | 7 +++++++
 ...t.java => SingleElementAnnotationInspectionTest.java} | 8 ++++----
 6 files changed, 21 insertions(+), 21 deletions(-)
 rename plugins/InspectionGadgets/src/com/siyeh/ig/annotation/{ExpandToNormalAnnotationInspection.java => SingleElementAnnotationInspection.java} (91%)
 delete mode 100644 plugins/InspectionGadgets/src/inspectionDescriptions/ExpandToNormalAnnotation.html
 create mode 100644 plugins/InspectionGadgets/src/inspectionDescriptions/SingleElementAnnotation.html
 rename plugins/InspectionGadgets/testsrc/com/siyeh/ig/fixes/style/{ExpandToNormalAnnotationInspectionTest.java => SingleElementAnnotationInspectionTest.java} (82%)

diff --git a/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/META-INF/InspectionGadgets.xml b/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/META-INF/InspectionGadgets.xml
index d20aada1dcda..69c63e843b0e 100644
--- a/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/META-INF/InspectionGadgets.xml
+++ b/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/META-INF/InspectionGadgets.xml
@@ -2547,10 +2547,10 @@
                      key="split.multi.catch.name" groupBundle="messages.InspectionsBundle"
                      groupKey="group.names.code.style.issues" enabledByDefault="true" level="INFORMATION"
                      implementationClass="com.siyeh.ig.exceptions.SplitMultiCatchInspection"/>
-    <localInspection groupPath="Java" language="JAVA" shortName="ExpandToNormalAnnotation" bundle="com.siyeh.InspectionGadgetsBundle"
-                     key="expand.to.normal.annotation.name" groupBundle="messages.InspectionsBundle"
+    <localInspection groupPath="Java" language="JAVA" shortName="SingleElementAnnotation" bundle="com.siyeh.InspectionGadgetsBundle"
+                     key="single.element.annotation.name" groupBundle="messages.InspectionsBundle"
                      groupKey="group.names.code.style.issues" enabledByDefault="true" level="INFORMATION"
-                     implementationClass="com.siyeh.ig.annotation.ExpandToNormalAnnotationInspection"/>
+                     implementationClass="com.siyeh.ig.annotation.SingleElementAnnotationInspection"/>
     <localInspection groupPath="Java" language="JAVA" shortName="AddArrayCreationExpression" bundle="com.siyeh.InspectionGadgetsBundle"
                      key="add.array.creation.expression.name" groupBundle="messages.InspectionsBundle"
                      groupKey="group.names.code.style.issues" enabledByDefault="true" level="INFORMATION"
diff --git a/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/InspectionGadgetsBundle.properties b/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/InspectionGadgetsBundle.properties
index c66268e2695a..237b1316765c 100644
--- a/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/InspectionGadgetsBundle.properties
+++ b/plugins/InspectionGadgets/InspectionGadgetsAnalysis/src/com/siyeh/InspectionGadgetsBundle.properties
@@ -2182,9 +2182,9 @@ single.statement.in.block.name=Code block contains single statement
 single.statement.in.block.descriptor=''{0}'' contains single statement
 single.statement.in.block.quickfix=Remove braces from ''{0}'' statement
 single.statement.in.block.family.quickfix=Remove braces from statement
-expand.to.normal.annotation.name=Single-element annotation
-expand.to.normal.annotation.quickfix=Add 'value='
-expand.to.normal.annotation.family.quickfix=Expand annotation to normal form
+single.element.annotation.name=Single-element annotation
+single.element.annotation.quickfix=Add 'value='
+single.element.annotation.family.quickfix=Expand annotation to normal form
 add.array.creation.expression.name=Add array creation expression
 add.array.creation.expression.descriptor=Add ''new {0}''
 malformed.set.up.tear.down.display.name=Malformed 'setUp()' or 'tearDown()'
diff --git a/plugins/InspectionGadgets/src/com/siyeh/ig/annotation/ExpandToNormalAnnotationInspection.java b/plugins/InspectionGadgets/src/com/siyeh/ig/annotation/SingleElementAnnotationInspection.java
similarity index 91%
rename from plugins/InspectionGadgets/src/com/siyeh/ig/annotation/ExpandToNormalAnnotationInspection.java
rename to plugins/InspectionGadgets/src/com/siyeh/ig/annotation/SingleElementAnnotationInspection.java
index 08c506033655..1905f0ab00db 100644
--- a/plugins/InspectionGadgets/src/com/siyeh/ig/annotation/ExpandToNormalAnnotationInspection.java
+++ b/plugins/InspectionGadgets/src/com/siyeh/ig/annotation/SingleElementAnnotationInspection.java
@@ -28,15 +28,14 @@ import org.jetbrains.annotations.Nls;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-import java.util.Collections;
 import java.util.Set;
 
-public class ExpandToNormalAnnotationInspection extends BaseInspection {
+public class SingleElementAnnotationInspection extends BaseInspection {
   @Nls
   @NotNull
   @Override
   public String getDisplayName() {
-    return InspectionGadgetsBundle.message("expand.to.normal.annotation.name");
+    return InspectionGadgetsBundle.message("single.element.annotation.name");
   }
 
   @NotNull
@@ -61,14 +60,14 @@ public class ExpandToNormalAnnotationInspection extends BaseInspection {
     @NotNull
     @Override
     public String getName() {
-      return InspectionGadgetsBundle.message("expand.to.normal.annotation.quickfix");
+      return InspectionGadgetsBundle.message("single.element.annotation.quickfix");
     }
 
     @Nls
     @NotNull
     @Override
     public String getFamilyName() {
-      return InspectionGadgetsBundle.message("expand.to.normal.annotation.family.quickfix");
+      return InspectionGadgetsBundle.message("single.element.annotation.family.quickfix");
     }
 
     @Override
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ExpandToNormalAnnotation.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ExpandToNormalAnnotation.html
deleted file mode 100644
index b23c67605ffc..000000000000
--- a/plugins/InspectionGadgets/src/inspectionDescriptions/ExpandToNormalAnnotation.html
+++ /dev/null
@@ -1,6 +0,0 @@
-<html>
-<body>
-This inspection reports annotations in the <i>single-element</i> form, like @Retention(RUNTIME).
-<p>The quick fix for this inspection converts annotation to the <i>normal</i> form (with attribute name), e.g. @Retention(value=RUNTIME).
-</body>
-</html>
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/SingleElementAnnotation.html b/plugins/InspectionGadgets/src/inspectionDescriptions/SingleElementAnnotation.html
new file mode 100644
index 000000000000..a286ebcfd796
--- /dev/null
+++ b/plugins/InspectionGadgets/src/inspectionDescriptions/SingleElementAnnotation.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+This inspection reports annotations in the 'single element' shorthand form, like <code>@Retention(RUNTIME)</code>.
+<p>The quick fix for this inspection converts annotation to the 'normal' form (with attribute name),
+e.g. <code>@Retention(value=RUNTIME)</code>.
+</body>
+</html>
diff --git a/plugins/InspectionGadgets/testsrc/com/siyeh/ig/fixes/style/ExpandToNormalAnnotationInspectionTest.java b/plugins/InspectionGadgets/testsrc/com/siyeh/ig/fixes/style/SingleElementAnnotationInspectionTest.java
similarity index 82%
rename from plugins/InspectionGadgets/testsrc/com/siyeh/ig/fixes/style/ExpandToNormalAnnotationInspectionTest.java
rename to plugins/InspectionGadgets/testsrc/com/siyeh/ig/fixes/style/SingleElementAnnotationInspectionTest.java
index b3b89251a521..a4e8f313cf6d 100644
--- a/plugins/InspectionGadgets/testsrc/com/siyeh/ig/fixes/style/ExpandToNormalAnnotationInspectionTest.java
+++ b/plugins/InspectionGadgets/testsrc/com/siyeh/ig/fixes/style/SingleElementAnnotationInspectionTest.java
@@ -17,9 +17,9 @@ package com.siyeh.ig.fixes.style;
 
 import com.siyeh.InspectionGadgetsBundle;
 import com.siyeh.ig.IGQuickFixesTestCase;
-import com.siyeh.ig.annotation.ExpandToNormalAnnotationInspection;
+import com.siyeh.ig.annotation.SingleElementAnnotationInspection;
 
-public class ExpandToNormalAnnotationInspectionTest extends IGQuickFixesTestCase {
+public class SingleElementAnnotationInspectionTest extends IGQuickFixesTestCase {
 
   public void testOneAttr() {
     doTest();
@@ -64,8 +64,8 @@ public class ExpandToNormalAnnotationInspectionTest extends IGQuickFixesTestCase
   @Override
   protected void setUp() throws Exception {
     super.setUp();
-    myFixture.enableInspections(new ExpandToNormalAnnotationInspection());
-    myDefaultHint = InspectionGadgetsBundle.message("expand.to.normal.annotation.quickfix");
+    myFixture.enableInspections(new SingleElementAnnotationInspection());
+    myDefaultHint = InspectionGadgetsBundle.message("single.element.annotation.quickfix");
     myRelativePath = "style/expand_annotation";
   }
 }