Static fixes

Author: Vitaliy Boyko

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

@@ -14,6 +14,14 @@ public class CategoryFormXmlData {
     private final String attributeInput;
     private final int sortOrder;
 
+    /**
+     * Category Form data class.
+     *
+     * @param fieldSetName name of the fieldset
+     * @param fieldName field name
+     * @param attributeInput attribute input
+     * @param sortOrder sort order
+     */
     public CategoryFormXmlData(
             @NotNull final String fieldSetName,
             @NotNull final String fieldName,

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

@@ -1,3 +1,8 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 import java.util.Map;

src/com/magento/idea/magento2plugin/actions/generation/dialog/event/eavdialog/OptionsPanelVisibilityChangeListener.java

@@ -30,7 +30,8 @@ public OptionsPanelVisibilityChangeListener(
     public void itemStateChanged(final ItemEvent itemEvent) {
         final String selectedSource = itemEvent.getItem().toString();
 
-        final ComboBoxItemData selectedInputItem = (ComboBoxItemData) inputComboBox.getSelectedItem();
+        final ComboBoxItemData selectedInputItem =
+                (ComboBoxItemData) inputComboBox.getSelectedItem();
         final String selectedInput = selectedInputItem == null ? "" : selectedInputItem.toString();
 
         final boolean isAttributeWithoutSource =

src/com/magento/idea/magento2plugin/actions/generation/eavattribute/NewCategoryEavAttributeAction.java

@@ -1,3 +1,8 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
 package com.magento.idea.magento2plugin.actions.generation.eavattribute;
 
 import com.intellij.openapi.project.Project;

src/com/magento/idea/magento2plugin/actions/generation/generator/CategoryFormXmlGenerator.java

@@ -16,7 +16,10 @@
 import com.intellij.psi.xml.XmlFile;
 import com.intellij.psi.xml.XmlTag;
 import com.magento.idea.magento2plugin.actions.generation.data.CategoryFormXmlData;
-import com.magento.idea.magento2plugin.actions.generation.generator.util.*;
+import com.magento.idea.magento2plugin.actions.generation.generator.util.DirectoryGenerator;
+import com.magento.idea.magento2plugin.actions.generation.generator.util.FileFromTemplateGenerator;
+import com.magento.idea.magento2plugin.actions.generation.generator.util.GetCodeTemplateUtil;
+import com.magento.idea.magento2plugin.actions.generation.generator.util.XmlFilePositionUtil;
 import com.magento.idea.magento2plugin.bundles.CommonBundle;
 import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
@@ -45,6 +48,13 @@ public class CategoryFormXmlGenerator extends FileGenerator {
     private final CommonBundle commonBundle;
     private boolean allowedFieldsetNodeInclude = true;
 
+    /**
+     * Category form XML Generator.
+     *
+     * @param categoryFormXmlData Category form data class
+     * @param project Project
+     * @param moduleName module name
+     */
     public CategoryFormXmlGenerator(
             final @NotNull CategoryFormXmlData categoryFormXmlData,
             final @NotNull Project project,
@@ -141,11 +151,11 @@ private PsiDirectory getFileDirectory() {
                 new ModuleIndex(project).getModuleDirectoryByModuleName(moduleName);
 
         for (final String handlerDirectory: CategoryFormXmlFile.DIRECTORY.split(File.separator)) {
-             directory = directoryGenerator.findOrCreateSubdirectory(
-                     directory,
-                     handlerDirectory
-             );
-         }
+            directory = directoryGenerator.findOrCreateSubdirectory(
+                directory,
+                handlerDirectory
+            );
+        }
         return directory;
     }
 
@@ -190,9 +200,14 @@ private List<XmlTag> findFieldsetTagsInRoot(final XmlTag rootTag) {
     }
 
     @Nullable
-    private XmlTag findMatchedFieldsetByName(final List<XmlTag> fieldsetList, final String fieldsetName) {
+    private XmlTag findMatchedFieldsetByName(
+            final List<XmlTag> fieldsetList,
+            final String fieldsetName
+    ) {
         for (final XmlTag fieldset: fieldsetList) {
-            final String attributeValue = fieldset.getAttributeValue(CategoryFormXmlFile.XML_ATTR_FIELDSET_NAME);
+            final String attributeValue = fieldset.getAttributeValue(
+                    CategoryFormXmlFile.XML_ATTR_FIELDSET_NAME
+            );
             if (attributeValue != null && attributeValue.equals(fieldsetName)) {
                 return fieldset;
             }

src/com/magento/idea/magento2plugin/actions/generation/generator/util/GetAttributeOptionPropertiesUtil.java

@@ -11,8 +11,8 @@
 import org.jetbrains.annotations.NotNull;
 
 public final class GetAttributeOptionPropertiesUtil {
-    public final static String OPTION_VALUE = "Value";
-    public final static String OPTION_SORT_ORDER = "Sort Order";
+    public static final String OPTION_VALUE = "Value";
+    public static final String OPTION_SORT_ORDER = "Sort Order";
 
     private GetAttributeOptionPropertiesUtil() {}
 

src/com/magento/idea/magento2plugin/actions/generation/generator/util/eav/AttributeMapperInterface.java

@@ -1,3 +1,8 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
 package com.magento.idea.magento2plugin.actions.generation.generator.util.eav;
 
 import com.magento.idea.magento2plugin.actions.generation.data.EavEntityDataInterface;

src/com/magento/idea/magento2plugin/magento/packages/uicomponent/AvailableSourcesByInput.java

@@ -19,6 +19,11 @@ public AvailableSourcesByInput(@NotNull final String input) {
         this.input = input;
     }
 
+    /**
+     * Source items getter.
+     *
+     * @return List
+     */
     public List<ComboBoxItemData> getItems() {
         final List<ComboBoxItemData> items = new ArrayList<>();
         final ComboBoxItemData generateSourceItem = new ComboBoxItemData(

src/com/magento/idea/magento2plugin/reference/js/JsReferenceContributor.java

@@ -2,34 +2,40 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.reference.js;
 
+import static com.intellij.patterns.StandardPatterns.string;
+
 import com.intellij.lang.javascript.patterns.JSPatterns;
-import com.intellij.psi.*;
+import com.intellij.psi.PsiReferenceContributor;
+import com.intellij.psi.PsiReferenceRegistrar;
 import com.magento.idea.magento2plugin.reference.provider.FilePathReferenceProvider;
 import com.magento.idea.magento2plugin.reference.provider.ModuleNameReferenceProvider;
 import com.magento.idea.magento2plugin.reference.provider.RequireJsPreferenceReferenceProvider;
 import com.magento.idea.magento2plugin.util.RegExUtil;
 import org.jetbrains.annotations.NotNull;
 
-import static com.intellij.patterns.StandardPatterns.string;
-
 public class JsReferenceContributor extends PsiReferenceContributor {
     @Override
-    public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar) {
+    public void registerReferenceProviders(@NotNull final PsiReferenceRegistrar registrar) {
         registrar.registerReferenceProvider(
                 JSPatterns.jsLiteralExpression()
                         .withText(string().matches(".*" + RegExUtil.Magento.MODULE_NAME + ".*")),
                 new ModuleNameReferenceProvider()
         );
 
         registrar.registerReferenceProvider(
-                JSPatterns.jsLiteralExpression().withText(string().matches(".*\\W" + RegExUtil.FILE_PATH + ".*")),
+                JSPatterns.jsLiteralExpression().withText(
+                        string().matches(".*\\W" + RegExUtil.FILE_PATH + ".*")
+                ),
                 new FilePathReferenceProvider()
         );
 
         registrar.registerReferenceProvider(
-                JSPatterns.jsLiteralExpression().withText(string().matches(".*\\W" + RegExUtil.FILE_PATH + ".*")),
+                JSPatterns.jsLiteralExpression().withText(
+                        string().matches(".*\\W" + RegExUtil.FILE_PATH + ".*")
+                ),
                 new RequireJsPreferenceReferenceProvider()
         );
     }

src/com/magento/idea/magento2plugin/stubs/indexes/xml/ProductTypeIndex.java

@@ -10,7 +10,11 @@
 import com.intellij.psi.xml.XmlDocument;
 import com.intellij.psi.xml.XmlFile;
 import com.intellij.psi.xml.XmlTag;
-import com.intellij.util.indexing.*;
+import com.intellij.util.indexing.DataIndexer;
+import com.intellij.util.indexing.FileBasedIndex;
+import com.intellij.util.indexing.FileContent;
+import com.intellij.util.indexing.ID;
+import com.intellij.util.indexing.ScalarIndexExtension;
 import com.intellij.util.io.EnumeratorStringDescriptor;
 import com.intellij.util.io.KeyDescriptor;
 import com.magento.idea.magento2plugin.magento.files.ProductTypeXml;
@@ -20,7 +24,7 @@
 import org.jetbrains.annotations.NotNull;
 
 public class ProductTypeIndex extends ScalarIndexExtension<String> {
-    private final static String TEST_DIRECTORY_PATTERN = ".*\\/[Tt]ests?\\/?.*";
+    private static final String TEST_DIRECTORY_PATTERN = ".*\\/[Tt]ests?\\/?.*";
     private final KeyDescriptor<String> myKeyDescriptor = new EnumeratorStringDescriptor();
     public static final ID<String, Void> KEY = ID.create(
             "com.magento.idea.magento2plugin.stubs.indexes.product_types");
@@ -69,7 +73,9 @@ DataIndexer<String, Void, FileContent> getIndexer() {
 
     private void parseRootTag(final Map<String, Void> map, final XmlTag xmlRootTag) {
         for (final XmlTag productTypeTag : xmlRootTag.findSubTags(ProductTypeXml.XML_TAG_TYPE)) {
-            final String productTypeName = productTypeTag.getAttributeValue(ProductTypeXml.XML_ATTRIBUTE_NAME);
+            final String productTypeName = productTypeTag.getAttributeValue(
+                    ProductTypeXml.XML_ATTRIBUTE_NAME
+            );
             map.put(productTypeName, null);
         }
     }
@@ -86,6 +92,7 @@ public int getVersion() {
     }
 
     @Override
+    @SuppressWarnings({"PMD.LiteralsFirstInComparisons"})
     public FileBasedIndex.InputFilter getInputFilter() {
         return file ->
                 file.getFileType() == XmlFileType.INSTANCE

src/com/magento/idea/magento2plugin/util/magento/GetProductTypesListUtil.java

@@ -12,10 +12,16 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
-public final class GetProductTypesListUtil
-{
+public final class GetProductTypesListUtil {
+
     private GetProductTypesListUtil() {}
 
+    /**
+     * Product types util.
+     *
+     * @param project Project
+     * @return List
+     */
     public static List<String> execute(final Project project) {
         final Collection<String> productTypesList =
                 FileBasedIndex.getInstance().getAllKeys(ProductTypeIndex.KEY, project);

tests/com/magento/idea/magento2plugin/actions/generation/generator/CategoryAttributePropertySetupPatchGeneratorTest.java

@@ -14,8 +14,11 @@
 
 public class CategoryAttributePropertySetupPatchGeneratorTest extends BaseGeneratorTestCase {
 
-    private final static String MODULE_NAME = "Foo_Bar";
+    private static final String MODULE_NAME = "Foo_Bar";
 
+    /**
+     * Tests the generated patch file.
+     */
     public void testGenerateFile() {
         final Project project = myFixture.getProject();
 
@@ -41,9 +44,16 @@ public void testGenerateFile() {
         final String filePatch = this.getFixturePath("AddTestAttributeCategoryAttribute.php");
         final PsiFile expectedFile = myFixture.configureByFile(filePatch);
 
-        assertGeneratedFileIsCorrect(expectedFile, "src/app/code/Foo/Bar/Setup/Patch/Data", dataPatchFile);
+        assertGeneratedFileIsCorrect(
+                expectedFile,
+                "src/app/code/Foo/Bar/Setup/Patch/Data",
+                dataPatchFile
+        );
     }
 
+    /**
+     * Tests the generated form file.
+     */
     public void testGenerateFormFile() {
         final Project project = myFixture.getProject();
 
@@ -75,6 +85,10 @@ public void testGenerateFormFile() {
         final String fileCategoryForm = this.getFixturePath("category_form.xml");
         final PsiFile expectedCategoryFile = myFixture.configureByFile(fileCategoryForm);
 
-        assertGeneratedFileIsCorrect(expectedCategoryFile, "src/app/code/Foo/Bar/view/adminhtml/ui_component", categoryForm);
+        assertGeneratedFileIsCorrect(
+                expectedCategoryFile,
+                "src/app/code/Foo/Bar/view/adminhtml/ui_component",
+                categoryForm
+        );
     }
 }