Add code adjustments

Author: Sergiy Zhovnir

src/com/magento/idea/magento2plugin/actions/generation/NewControllerAction.java

@@ -2,20 +2,25 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation;
 
 import com.intellij.ide.IdeView;
 import com.intellij.openapi.actionSystem.*;
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiDirectory;
-import com.magento.idea.magento2plugin.MagentoIcons;
 import com.magento.idea.magento2plugin.actions.generation.dialog.NewControllerDialog;
+import com.magento.idea.magento2plugin.MagentoIcons;
 import org.jetbrains.annotations.NotNull;
 
+@SuppressWarnings({"PMD.OnlyOneReturn"})
 public class NewControllerAction extends AnAction {
     public static String ACTION_NAME = "Magento 2 Controller";
     public static String ACTION_DESCRIPTION = "Create a new Magento 2 controller";
 
+    /**
+     * New controller action constructor.
+     */
     NewControllerAction() {
         super(ACTION_NAME, ACTION_DESCRIPTION, MagentoIcons.MODULE);
     }

src/com/magento/idea/magento2plugin/actions/generation/data/ControllerFileData.java

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 public class ControllerFileData {
@@ -14,6 +15,18 @@ public class ControllerFileData {
     private Boolean isInheritClass;
     private String namespace;
 
+    /**
+     * Controller data file constructor.
+     *
+     * @param actionDirectory String
+     * @param controllerClassName String
+     * @param controllerModule String
+     * @param controllerArea String
+     * @param httpMethodName String
+     * @param acl String
+     * @param isInheritClass Boolean
+     * @param namespace String
+     */
     public ControllerFileData(
             String actionDirectory,
             String controllerClassName,
@@ -34,34 +47,74 @@ public ControllerFileData(
         this.namespace = namespace;
     }
 
+    /**
+     * Get action directory.
+     *
+     * @return String
+     */
     public String getActionDirectory() {
         return actionDirectory;
     }
 
+    /**
+     * Get action class name.
+     *
+     * @return String
+     */
     public String getActionClassName() {
         return actionClassName;
     }
 
+    /**
+     * Get controller module.
+     *
+     * @return String
+     */
     public String getControllerModule() {
         return controllerModule;
     }
 
+    /**
+     * Get namespace.
+     *
+     * @return String
+     */
     public String getNamespace() {
         return namespace;
     }
 
+    /**
+     * Get controller area.
+     *
+     * @return String
+     */
     public String getControllerArea() {
         return controllerArea;
     }
 
+    /**
+     * Get HTTP method name.
+     *
+     * @return String
+     */
     public String getHttpMethodName() {
         return httpMethodName;
     }
 
+    /**
+     * Get ACL.
+     *
+     * @return String
+     */
     public String getAcl() {
         return acl;
     }
 
+    /**
+     * Get is inherit class.
+     *
+     * @return String
+     */
     public Boolean getIsInheritClass() {
         return isInheritClass;
     }

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewControllerDialog.java

@@ -8,31 +8,31 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiFile;
-import com.magento.idea.magento2plugin.actions.generation.NewControllerAction;
 import com.magento.idea.magento2plugin.actions.generation.data.ControllerFileData;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.NewControllerValidator;
 import com.magento.idea.magento2plugin.actions.generation.generator.ModuleControllerClassGenerator;
+import com.magento.idea.magento2plugin.actions.generation.NewControllerAction;
 import com.magento.idea.magento2plugin.magento.files.ControllerBackendPhp;
 import com.magento.idea.magento2plugin.magento.files.ControllerFrontendPhp;
 import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2plugin.magento.packages.HttpRequest;
 import com.magento.idea.magento2plugin.magento.packages.Package;
 import com.magento.idea.magento2plugin.ui.FilteredComboBox;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectory;
-import javax.swing.JPanel;
-import javax.swing.JButton;
-import javax.swing.JLabel;
-import javax.swing.JTextField;
-import javax.swing.JCheckBox;
-import javax.swing.JComponent;
-import javax.swing.KeyStroke;
-import java.awt.event.WindowAdapter;
-import java.awt.event.WindowEvent;
-import java.awt.event.ActionListener;
 import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
 import java.awt.event.KeyEvent;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
 import java.util.ArrayList;
 import java.util.Arrays;
+import javax.swing.JButton;
+import javax.swing.JCheckBox;
+import javax.swing.JComponent;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.JTextField;
+import javax.swing.KeyStroke;
 
 public class NewControllerDialog extends AbstractDialog {
     private final NewControllerValidator validator;
@@ -255,8 +255,7 @@ protected void onCancel() {
         dispose();
     }
 
-    private ArrayList<String> getAreaList()
-    {
+    private ArrayList<String> getAreaList() {
         return new ArrayList<>(
                 Arrays.asList(
                         Package.Areas.frontend.toString(),

src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/CreateAPluginDialogValidator.java

@@ -9,11 +9,11 @@
 import com.jetbrains.php.refactoring.PhpNameUtil;
 import com.magento.idea.magento2plugin.actions.generation.dialog.CreateAPluginDialog;
 import com.magento.idea.magento2plugin.bundles.CommonBundle;
+import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.util.RegExUtil;
-import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
-import javax.swing.JOptionPane;
 import java.util.List;
+import javax.swing.JOptionPane;
 
 @SuppressWarnings({"PMD.OnlyOneReturn"})
 public class CreateAPluginDialogValidator {
@@ -38,6 +38,9 @@ public static CreateAPluginDialogValidator getInstance(CreateAPluginDialog dialo
         return INSTANCE;
     }
 
+    /**
+     * Create a plugin dialog validator.
+     */
     public CreateAPluginDialogValidator() {
         this.validatorBundle = new ValidatorBundle();
         this.commonBundle = new CommonBundle();
@@ -50,8 +53,7 @@ public CreateAPluginDialogValidator() {
      *
      * @return Boolean
      */
-    public boolean validate(Project project)
-    {
+    public boolean validate(Project project) {
         String errorTitle = commonBundle.message("common.error");
         String pluginClassName = dialog.getPluginClassName();
 

src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/CreateAnObserverDialogValidator.java

@@ -9,11 +9,11 @@
 import com.jetbrains.php.refactoring.PhpNameUtil;
 import com.magento.idea.magento2plugin.actions.generation.dialog.CreateAnObserverDialog;
 import com.magento.idea.magento2plugin.bundles.CommonBundle;
+import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.util.RegExUtil;
-import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
-import javax.swing.JOptionPane;
 import java.util.List;
+import javax.swing.JOptionPane;
 
 @SuppressWarnings({"PMD.OnlyOneReturn"})
 public class CreateAnObserverDialogValidator {
@@ -37,6 +37,9 @@ public static CreateAnObserverDialogValidator getInstance(CreateAnObserverDialog
         return INSTANCE;
     }
 
+    /**
+     * Create an observer dialog validator.
+     */
     public CreateAnObserverDialogValidator() {
         this.validatorBundle = new ValidatorBundle();
         this.commonBundle = new CommonBundle();
@@ -49,8 +52,7 @@ public CreateAnObserverDialogValidator() {
      *
      * @return Boolean
      */
-    public boolean validate(Project project)
-    {
+    public boolean validate(Project project) {
         String errorTitle = commonBundle.message("common.error");
         String observerClassName = dialog.getObserverClassName();
 

src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/NewBlockValidator.java

@@ -8,8 +8,8 @@
 import com.jetbrains.php.refactoring.PhpNameUtil;
 import com.magento.idea.magento2plugin.actions.generation.dialog.NewBlockDialog;
 import com.magento.idea.magento2plugin.bundles.CommonBundle;
-import com.magento.idea.magento2plugin.util.RegExUtil;
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
+import com.magento.idea.magento2plugin.util.RegExUtil;
 import javax.swing.JOptionPane;
 
 @SuppressWarnings({"PMD.OnlyOneReturn"})
@@ -34,6 +34,9 @@ public static NewBlockValidator getInstance(NewBlockDialog dialog) {
         return INSTANCE;
     }
 
+    /**
+     * New block validator constructor.
+     */
     public NewBlockValidator() {
         this.validatorBundle = new ValidatorBundle();
         this.commonBundle = new CommonBundle();
@@ -44,8 +47,7 @@ public NewBlockValidator() {
      *
      * @return Boolean
      */
-    public boolean validate()
-    {
+    public boolean validate() {
         String errorTitle = commonBundle.message("common.error");
         String moduleName = dialog.getBlockName();
 

src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/NewControllerValidator.java

@@ -35,8 +35,10 @@ public static NewControllerValidator getInstance(NewControllerDialog dialog) {
         return INSTANCE;
     }
 
-    public NewControllerValidator()
-    {
+    /**
+     * New controller validator constructor.
+     */
+    public NewControllerValidator() {
         this.validatorBundle = new ValidatorBundle();
         this.commonBundle = new CommonBundle();
     }
@@ -46,8 +48,7 @@ public NewControllerValidator()
      *
      * @return Boolean
      */
-    public boolean validate()
-    {
+    public boolean validate() {
         String errorTitle = commonBundle.message("common.error");
         String actionName = dialog.getActionName();