Fixed PMD issues

drpayyne · drpayyne · commit 25ccdb40b54f · 2020-12-05T13:32:12.000+05:30
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/QueueCommunicationData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/QueueCommunicationData.java
@@ -6,21 +6,21 @@
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 public class QueueCommunicationData {
-    private String topicName;
-    private String handlerName;
-    private String handlerType;
-    private String handlerMethod;
-    private String moduleName;
+    private final String topicName;
+    private final String handlerName;
+    private final String handlerType;
+    private final String handlerMethod;
+    private final String moduleName;
 
     /**
      * Constructor.
      */
     public QueueCommunicationData(
-            String topicName,
-            String handlerName,
-            String handlerType,
-            String handlerMethod,
-            String moduleName
+            final String topicName,
+            final String handlerName,
+            final String handlerType,
+            final String handlerMethod,
+            final String moduleName
     ) {
         this.topicName = topicName;
         this.handlerName = handlerName;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/QueueConsumerData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/QueueConsumerData.java
@@ -6,23 +6,23 @@
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 public class QueueConsumerData {
-    private String consumerName;
-    private String queueName;
-    private String consumerType;
-    private String maxMessages;
-    private String connectionName;
-    private String moduleName;
+    private final String consumerName;
+    private final String queueName;
+    private final String consumerType;
+    private final String maxMessages;
+    private final String connectionName;
+    private final String moduleName;
 
     /**
      * Constructor.
      */
     public QueueConsumerData(
-            String consumerName,
-            String queueName,
-            String consumerType,
-            String maxMessages,
-            String connectionName,
-            String moduleName
+            final String consumerName,
+            final String queueName,
+            final String consumerType,
+            final String maxMessages,
+            final String connectionName,
+            final String moduleName
     ) {
         this.consumerName = consumerName;
         this.queueName = queueName;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/QueuePublisherData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/QueuePublisherData.java
@@ -6,19 +6,19 @@
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 public class QueuePublisherData {
-    private String topicName;
-    private String connectionName;
-    private String exchangeName;
-    private String moduleName;
+    private final String topicName;
+    private final String connectionName;
+    private final String exchangeName;
+    private final String moduleName;
 
     /**
      * Constructor.
      */
     public QueuePublisherData(
-            String topicName,
-            String connectionName,
-            String exchangeName,
-            String moduleName
+            final String topicName,
+            final String connectionName,
+            final String exchangeName,
+            final String moduleName
     ) {
         this.topicName = topicName;
         this.connectionName = connectionName;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/QueueTopologyData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/QueueTopologyData.java
@@ -6,23 +6,23 @@
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 public class QueueTopologyData {
-    private String exchangeName;
-    private String connectionName;
-    private String bindingId;
-    private String bindingTopic;
-    private String bindingQueue;
-    private String moduleName;
+    private final String exchangeName;
+    private final String connectionName;
+    private final String bindingId;
+    private final String bindingTopic;
+    private final String bindingQueue;
+    private final String moduleName;
 
     /**
      * Constructor.
      */
     public QueueTopologyData(
-            String exchangeName,
-            String connectionName,
-            String bindingId,
-            String bindingTopic,
-            String bindingQueue,
-            String moduleName
+            final String exchangeName,
+            final String connectionName,
+            final String bindingId,
+            final String bindingTopic,
+            final String bindingQueue,
+            final String moduleName
     ) {
         this.exchangeName = exchangeName;
         this.connectionName = connectionName;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMessageQueueDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewMessageQueueDialog.java
@@ -37,6 +37,10 @@
 import javax.swing.JTextField;
 import javax.swing.KeyStroke;
 
+@SuppressWarnings({
+        "PMD.TooManyFields",
+        "PMD.ExcessiveImports",
+})
 public class NewMessageQueueDialog extends AbstractDialog {
     private static final String TOPIC_NAME = "Topic Name";
     private static final String HANDLER_NAME = "Handler Name";
@@ -131,7 +135,7 @@ public class NewMessageQueueDialog extends AbstractDialog {
     /**
      * Constructor.
      */
-    public NewMessageQueueDialog(Project project, PsiDirectory directory) {
+    public NewMessageQueueDialog(final Project project, final PsiDirectory directory) {
         super();
 
         this.project = project;
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/QueueCommunicationGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/QueueCommunicationGenerator.java
@@ -20,6 +20,7 @@
 import org.jetbrains.annotations.Nullable;
 
 public class QueueCommunicationGenerator extends FileGenerator {
+    public static final String ATTRIBUTE_NAME = "name";
     private final QueueCommunicationData communicationData;
     private final Project project;
     private final FindOrCreateCommunicationXml findOrCreateCommunicationXml;
@@ -39,7 +40,7 @@ public QueueCommunicationGenerator(
     }
 
     @Override
-    public PsiFile generate(String actionName) {
+    public PsiFile generate(final String actionName) {
         final XmlFile communicationXml = (XmlFile) findOrCreateCommunicationXml.execute(
                 actionName,
                 communicationData.getModuleName()
@@ -52,27 +53,27 @@ public PsiFile generate(String actionName) {
             if (rootTag == null) {
                 return;
             }
-            XmlTag[] topicTags = rootTag.findSubTags("topic");
+            final XmlTag[] topicTags = rootTag.findSubTags("topic");
             boolean topicTagIsGenerated = true;
             XmlTag topicTag = null;
             for (final XmlTag tag: topicTags) {
-                if (communicationData.getTopicName().equals(tag.getAttribute("name").getValue())) {
+                if (communicationData.getTopicName().equals(tag.getAttribute(ATTRIBUTE_NAME).getValue())) {
                     topicTagIsGenerated = false;
                     topicTag = tag;
                     break;
                 }
             }
             if (topicTagIsGenerated) {
                 topicTag = rootTag.createChildTag("topic", null, "", false);
-                topicTag.setAttribute("name", communicationData.getTopicName());
+                topicTag.setAttribute(ATTRIBUTE_NAME, communicationData.getTopicName());
                 topicTag.setAttribute("request", "string");
                 topicTag.setAttribute("response", "string");
             }
 
             @NotNull final XmlTag[] handlerTags = topicTag.findSubTags("handler");
             boolean isDeclared = false;
             for (final XmlTag handlerTag: handlerTags) {
-                @Nullable final XmlAttribute handlerName = handlerTag.getAttribute("name");
+                @Nullable final XmlAttribute handlerName = handlerTag.getAttribute(ATTRIBUTE_NAME);
                 if (communicationData.getHandlerName().equals(handlerName.getValue())) {
                     isDeclared = true;
                 }
@@ -81,7 +82,7 @@ public PsiFile generate(String actionName) {
             if (!isDeclared) {
                 final XmlTag handlerTag = topicTag.createChildTag("handler", null, null, false);
 
-                handlerTag.setAttribute("name", communicationData.getHandlerName());
+                handlerTag.setAttribute(ATTRIBUTE_NAME, communicationData.getHandlerName());
                 handlerTag.setAttribute("type",communicationData.getHandlerType());
                 handlerTag.setAttribute("method",communicationData.getHandlerMethod());
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/QueueConsumerGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/QueueConsumerGenerator.java
@@ -46,7 +46,7 @@ public PsiFile generate(String actionName) {
             if (rootTag == null) {
                 return;
             }
-            XmlTag[] consumerTags = rootTag.findSubTags("consumer");
+            final XmlTag[] consumerTags = rootTag.findSubTags("consumer");
             boolean tagIsGenerated = true;
             for (final XmlTag tag: consumerTags) {
                 if (consumerData.getConsumerName().equals(tag.getAttribute("name").getValue())) {
@@ -55,7 +55,7 @@ public PsiFile generate(String actionName) {
                 }
             }
             if (tagIsGenerated) {
-                XmlTag consumerTag = rootTag.createChildTag("consumer", null, null, false);
+                final XmlTag consumerTag = rootTag.createChildTag("consumer", null, null, false);
                 consumerTag.setAttribute("name", consumerData.getConsumerName());
                 consumerTag.setAttribute("queue", consumerData.getQueueName());
                 consumerTag.setAttribute("consumerInstance", consumerData.getConsumerType());
@@ -72,5 +72,5 @@ public PsiFile generate(String actionName) {
     }
 
     @Override
-    protected void fillAttributes(Properties attributes) {}
+    protected void fillAttributes(Properties attributes) {}//NOPMD
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/QueuePublisherGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/QueuePublisherGenerator.java
@@ -39,7 +39,7 @@ public QueuePublisherGenerator(
     }
 
     @Override
-    public PsiFile generate(String actionName) {
+    public PsiFile generate(final String actionName) {
         final XmlFile publisherXml = (XmlFile) findOrCreateQueuePublisherXml.execute(
                 actionName,
                 publisherData.getModuleName()
@@ -52,7 +52,7 @@ public PsiFile generate(String actionName) {
             if (rootTag == null) {
                 return;
             }
-            XmlTag[] publisherTags = rootTag.findSubTags("publisher");
+            final XmlTag[] publisherTags = rootTag.findSubTags("publisher");
             boolean publisherTagIsGenerated = true;
             XmlTag publisherTag = null;
             for (final XmlTag tag: publisherTags) {
@@ -99,5 +99,5 @@ public PsiFile generate(String actionName) {
     }
 
     @Override
-    protected void fillAttributes(Properties attributes) {}
+    protected void fillAttributes(final Properties attributes) {}//NOPMD
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/QueueTopologyGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/QueueTopologyGenerator.java
@@ -27,7 +27,7 @@ public class QueueTopologyGenerator extends FileGenerator {
     /**
      * Constructor.
      */
-    public QueueTopologyGenerator(Project project, QueueTopologyData topologyData) {
+    public QueueTopologyGenerator(final Project project, final QueueTopologyData topologyData) {
         super(project);
 
         this.topologyData = topologyData;
@@ -36,7 +36,7 @@ public QueueTopologyGenerator(Project project, QueueTopologyData topologyData) {
     }
 
     @Override
-    public PsiFile generate(String actionName) {
+    public PsiFile generate(final String actionName) {
         final XmlFile topologyXml = (XmlFile) findOrCreateQueueTopologyXml.execute(
                 actionName,
                 topologyData.getModuleName()
@@ -49,7 +49,7 @@ public PsiFile generate(String actionName) {
             if (rootTag == null) {
                 return;
             }
-            XmlTag[] exchangeTags = rootTag.findSubTags("exchange");
+            final XmlTag[] exchangeTags = rootTag.findSubTags("exchange");
             boolean exchangeTagIsGenerated = true;
             XmlTag exchangeTag = null;
             for (final XmlTag tag: exchangeTags) {
@@ -98,5 +98,5 @@ public PsiFile generate(String actionName) {
     }
 
     @Override
-    protected void fillAttributes(Properties attributes) {}
+    protected void fillAttributes(Properties attributes) {}//NOPMD
 }

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public PsiFile generate(String actionName) {`
`46`	`46`	`if (rootTag == null) {`
`47`	`47`	`return;`
`48`	`48`	`}`
`49`		`- XmlTag[] consumerTags = rootTag.findSubTags("consumer");`
	`49`	`+ final XmlTag[] consumerTags = rootTag.findSubTags("consumer");`
`50`	`50`	`boolean tagIsGenerated = true;`
`51`	`51`	`for (final XmlTag tag: consumerTags) {`
`52`	`52`	`if (consumerData.getConsumerName().equals(tag.getAttribute("name").getValue())) {`
`@@ -55,7 +55,7 @@ public PsiFile generate(String actionName) {`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`	`if (tagIsGenerated) {`
`58`		`- XmlTag consumerTag = rootTag.createChildTag("consumer", null, null, false);`
	`58`	`+ final XmlTag consumerTag = rootTag.createChildTag("consumer", null, null, false);`
`59`	`59`	`consumerTag.setAttribute("name", consumerData.getConsumerName());`
`60`	`60`	`consumerTag.setAttribute("queue", consumerData.getQueueName());`
`61`	`61`	`consumerTag.setAttribute("consumerInstance", consumerData.getConsumerType());`
`@@ -72,5 +72,5 @@ public PsiFile generate(String actionName) {`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`@Override`
`75`		`- protected void fillAttributes(Properties attributes) {}`
	`75`	`+ protected void fillAttributes(Properties attributes) {}//NOPMD`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public QueuePublisherGenerator(`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`@Override`
`42`		`- public PsiFile generate(String actionName) {`
	`42`	`+ public PsiFile generate(final String actionName) {`
`43`	`43`	`final XmlFile publisherXml = (XmlFile) findOrCreateQueuePublisherXml.execute(`
`44`	`44`	`actionName,`
`45`	`45`	`publisherData.getModuleName()`
`@@ -52,7 +52,7 @@ public PsiFile generate(String actionName) {`
`52`	`52`	`if (rootTag == null) {`
`53`	`53`	`return;`
`54`	`54`	`}`
`55`		`- XmlTag[] publisherTags = rootTag.findSubTags("publisher");`
	`55`	`+ final XmlTag[] publisherTags = rootTag.findSubTags("publisher");`
`56`	`56`	`boolean publisherTagIsGenerated = true;`
`57`	`57`	`XmlTag publisherTag = null;`
`58`	`58`	`for (final XmlTag tag: publisherTags) {`
`@@ -99,5 +99,5 @@ public PsiFile generate(String actionName) {`
`99`	`99`	`}`
`100`	`100`
`101`	`101`	`@Override`
`102`		`- protected void fillAttributes(Properties attributes) {}`
	`102`	`+ protected void fillAttributes(final Properties attributes) {}//NOPMD`
`103`	`103`	`}`