Merge pull request #557 from Iamwade/static-fixes-for-validation-namespace

Vitaliy · web-flow · commit d0780f278a6c · 2021-04-20T15:35:19.000+03:00
Fixed copyrights, indentation and added @NotNull to methods
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/dialog/NewEmailTemplateDialogValidator.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/dialog/NewEmailTemplateDialogValidator.java
@@ -23,8 +23,10 @@
 import com.magento.idea.magento2plugin.util.xml.XmlPsiTreeUtil;
 import java.util.Collection;
 import javax.swing.JOptionPane;
+import org.jetbrains.annotations.NotNull;
 
 public class NewEmailTemplateDialogValidator {
+
     private final ValidatorBundle validatorBundle;
     private final CommonBundle commonBundle;
     private final Project project;
@@ -44,7 +46,7 @@ public NewEmailTemplateDialogValidator(final Project project) {
      * @param dialog NewEmailTemplateDialog
      * @return boolean
      */
-    public boolean validate(final NewEmailTemplateDialog dialog) {
+    public boolean validate(final @NotNull NewEmailTemplateDialog dialog) {
         final EmailTemplatesXmlData emailTemplatesXmlData = dialog.getEmailTemplateData();
         final String errorTitle = commonBundle.message("common.error");
         final EmailTemplateHtmlData emailTemplateHtmlData = dialog.getEmailTemplateHtmlData();
@@ -92,7 +94,9 @@ public boolean validate(final NewEmailTemplateDialog dialog) {
      *
      * @return bool
      */
-    private boolean isTemplateTagAlreadyExists(final EmailTemplatesXmlData emailTemplatesXmlData) {
+    private boolean isTemplateTagAlreadyExists(
+            final @NotNull EmailTemplatesXmlData emailTemplatesXmlData
+    ) {
         final EmailTemplatesXml emailTemplatesXml = new EmailTemplatesXml();
         final XmlFile emailTemplatesFile = (XmlFile) FileBasedIndexUtil.findModuleConfigFile(
                 emailTemplatesXml.getFileName(),
@@ -134,7 +138,7 @@ private boolean isTemplateTagAlreadyExists(final EmailTemplatesXmlData emailTemp
      * @return boolean
      */
     private boolean isTemplateFileAlreadyExists(
-            final EmailTemplateHtmlData emailTemplateData
+            final @NotNull EmailTemplateHtmlData emailTemplateData
     ) {
         final PsiFile templateFile = FileBasedIndexUtil.findModuleViewFile(
                 emailTemplateData.getFileName(),
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AclResourceIdRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AclResourceIdRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class AclResourceIdRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.magentoAclResourceIdInvalid";
     private static final ValidationRule INSTANCE = new AclResourceIdRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.Magento.XML_IDENTIFIER);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphaWithDashRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphaWithDashRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class AlphaWithDashRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.alphaAndDashCharacters";
     private static final ValidationRule INSTANCE = new AlphaWithDashRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.ALPHA_WITH_DASH);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphaWithPeriodRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphaWithPeriodRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class AlphaWithPeriodRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.alphaAndPeriodCharacters";
     private static final ValidationRule INSTANCE = new AlphaWithPeriodRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.ALPHA_WITH_PERIOD);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphanumericRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphanumericRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class AlphanumericRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.alphaNumericCharacters";
     private static final ValidationRule INSTANCE = new AlphanumericRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.ALPHANUMERIC);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphanumericWithUnderscoreRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/AlphanumericWithUnderscoreRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class AlphanumericWithUnderscoreRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.alphaNumericAndUnderscoreCharacters";
     private static final ValidationRule INSTANCE = new AlphanumericWithUnderscoreRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.ALPHANUMERIC_WITH_UNDERSCORE);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/BoxNotEmptyRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/BoxNotEmptyRule.java
@@ -5,12 +5,15 @@
 
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
+import org.jetbrains.annotations.NotNull;
+
 public class BoxNotEmptyRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.box.notEmpty";
     private static final ValidationRule INSTANCE = new BoxNotEmptyRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return !value.isEmpty();
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/CliCommandRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/CliCommandRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class CliCommandRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.command.isNotValid";
     private static final ValidationRule INSTANCE = new CliCommandRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.CLI_COMMAND_NAME);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/ConfigPathRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/ConfigPathRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class ConfigPathRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.configPath.invalidFormat";
     private static final ValidationRule INSTANCE = new ConfigPathRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.Magento.CONFIG_PATH);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/CronScheduleRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/CronScheduleRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class CronScheduleRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.cronSchedule.invalidExpression";
     private static final ValidationRule INSTANCE = new CronScheduleRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.Magento.CRON_SCHEDULE);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/DirectoryRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/DirectoryRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class DirectoryRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.directory.isNotValid";
     private static final ValidationRule INSTANCE = new DirectoryRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.DIRECTORY);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/IdentifierRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/IdentifierRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class IdentifierRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.identifier";
     private static final ValidationRule INSTANCE = new IdentifierRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.IDENTIFIER);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/IdentifierWithColonRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/IdentifierWithColonRule.java
@@ -1,13 +1,20 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class IdentifierWithColonRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.identifier.colon";
     private static final ValidationRule INSTANCE = new IdentifierWithColonRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.IDENTIFIER_WITH_COLON);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/Lowercase.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/Lowercase.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import java.util.Locale;
+import org.jetbrains.annotations.NotNull;
 
 public class Lowercase implements ValidationRule {
+
     public static final String MESSAGE = "validator.lowercaseCharacters";
     private static final ValidationRule INSTANCE = new Lowercase();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.equals(value.toLowerCase(Locale.getDefault()));
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/MenuIdentifierRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/MenuIdentifierRule.java
@@ -1,13 +1,20 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class MenuIdentifierRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.menuIdentifierInvalid";
     private static final ValidationRule INSTANCE = new MenuIdentifierRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.Magento.XML_IDENTIFIER);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/NotEmptyRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/NotEmptyRule.java
@@ -5,12 +5,15 @@
 
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
+import org.jetbrains.annotations.NotNull;
+
 public class NotEmptyRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.notEmpty";
     private static final ValidationRule INSTANCE = new NotEmptyRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return !value.isEmpty();
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/NumericRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/NumericRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class NumericRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.onlyNumbers";
     private static final ValidationRule INSTANCE = new NumericRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.NUMERIC);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpClassFqnRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpClassFqnRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class PhpClassFqnRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.fqn.isNotValid";
     private static final ValidationRule INSTANCE = new PhpClassFqnRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.Magento.PHP_CLASS_FQN);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpClassRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpClassRule.java
@@ -7,13 +7,15 @@
 
 import com.jetbrains.php.refactoring.PhpNameUtil;
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class PhpClassRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.class.isNotValid";
     private static final ValidationRule INSTANCE = new PhpClassRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.Magento.PHP_CLASS) && PhpNameUtil.isValidClassName(value);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpDirectoryRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpDirectoryRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.magento.idea.magento2plugin.util.RegExUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class PhpDirectoryRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.directory.php.isNotValid";
     private static final ValidationRule INSTANCE = new PhpDirectoryRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return value.matches(RegExUtil.Magento.PHP_CLASS);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpNamespaceNameRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/PhpNamespaceNameRule.java
@@ -6,13 +6,15 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
 
 import com.jetbrains.php.refactoring.PhpNameUtil;
+import org.jetbrains.annotations.NotNull;
 
 public class PhpNamespaceNameRule implements ValidationRule {
+
     public static final String MESSAGE = "validator.namespace.isNotValid";
     private static final ValidationRule INSTANCE = new PhpNamespaceNameRule();
 
     @Override
-    public boolean check(final String value) {
+    public boolean check(final @NotNull String value) {
         return PhpNameUtil.isValidNamespaceName(value);
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/RouteIdRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/RouteIdRule.java
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/StartWithNumberOrCapitalLetterRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/StartWithNumberOrCapitalLetterRule.java
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/TableNameLength.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/TableNameLength.java
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/ui/component/FormButtonsValidator.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/ui/component/FormButtonsValidator.java
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/ui/component/FormFieldsValidator.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/ui/component/FormFieldsValidator.java
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/ui/component/FormFieldsetsValidator.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/ui/component/FormFieldsetsValidator.java
