[212]_update code for check codestyle

Author: iamdylanngo

src/com/magento/idea/magento2plugin/completion/provider/PhpJobMethodCompletionContributor.java

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.completion.provider;
 
 import com.intellij.codeInsight.completion.CompletionParameters;

src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java

@@ -62,13 +62,6 @@ public XmlCompletionContributor() {
                         .inside(XmlPatterns.xmlAttribute().withName(CommonXml.ATTR_CLASS)),
                 new PhpClassCompletionProvider()
         );
-
-        // <randomTag instance="completion">
-        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
-                        .inside(XmlPatterns.xmlAttribute().withName(CommonXml.ATTR_INSTANCE)),
-                new PhpClassCompletionProvider()
-        );
-
         // <preference for="completion">
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
                         .inside(XmlPatterns.xmlAttribute().withName(ModuleDiXml.PREFERENCE_ATTR_FOR)),
@@ -135,12 +128,20 @@ public XmlCompletionContributor() {
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
             .inside(XmlPatterns.xmlAttribute().withName(ModuleEventsXml.INSTANCE_ATTRIBUTE)
                 .withParent(XmlPatterns.xmlTag().withName(ModuleEventsXml.OBSERVER_TAG)
-                    .withParent(XmlPatterns.xmlTag().withName(ModuleEventsXml.EVENT_TAG))
                 )
             ).inFile(xmlFile().withName(string().matches(ModuleEventsXml.FILE_NAME))),
             new PhpClassCompletionProvider()
         );
 
+        // <job instance="class">
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+            .inside(XmlPatterns.xmlAttribute().withName(CommonXml.ATTR_INSTANCE)
+                .withParent(XmlPatterns.xmlTag().withName(CrontabXmlTemplate.CRON_JOB_TAG)
+                )
+            ).inFile(xmlFile().withName(string().matches(CrontabXmlTemplate.FILE_NAME))),
+            new PhpClassCompletionProvider()
+        );
+
         // <source_model>php class completion</source_model> in system.xml files.
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_DATA_CHARACTERS)
             .inside(XmlPatterns.xmlTag().withName(ModuleSystemXml.XML_TAG_SOURCE_MODEL)

src/com/magento/idea/magento2plugin/indexes/DiIndex.java

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.indexes;
 
 import com.intellij.codeInsight.completion.PrefixMatcher;
@@ -12,19 +13,24 @@
 import com.intellij.psi.PsiReference;
 import com.intellij.psi.search.GlobalSearchScope;
 import com.intellij.psi.util.PsiTreeUtil;
-import com.intellij.psi.xml.*;
+// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
+import com.intellij.psi.xml.*;//NOPMD
 import com.intellij.util.indexing.FileBasedIndex;
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.stubs.indexes.VirtualTypeIndex;
 import com.magento.idea.magento2plugin.util.xml.XmlPsiTreeUtil;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
+// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
+/**
+ * TODO: enable style checks after decomposition.
+ */
+@SuppressWarnings({"PMD", "checkstyle:all"})
 public class DiIndex {
 
     private static DiIndex INSTANCE;
@@ -34,6 +40,12 @@ public class DiIndex {
     private DiIndex() {
     }
 
+    /**
+     * Get Instance.
+     *
+     * @param project
+     * @return DiIndex
+     */
     public static DiIndex getInstance(final Project project) {
         if (null == INSTANCE) {
             INSTANCE = new DiIndex();
@@ -42,6 +54,12 @@ public static DiIndex getInstance(final Project project) {
         return INSTANCE;
     }
 
+    /**
+     * Get Php Class Of Argument.
+     *
+     * @param psiArgumentValueElement
+     * @return PhpClass
+     */
     @Nullable
     public PhpClass getPhpClassOfArgument(XmlElement psiArgumentValueElement) {
 
@@ -66,6 +84,12 @@ public PhpClass getPhpClassOfArgument(XmlElement psiArgumentValueElement) {
         return null;
     }
 
+    /**
+     * Get Php Class Of Service Method.
+     *
+     * @param psiMethodValueElement
+     * @return PhpClass
+     */
     @Nullable
     public static PhpClass getPhpClassOfServiceMethod(XmlElement psiMethodValueElement) {
         XmlTag serviceTag = PsiTreeUtil.getParentOfType(psiMethodValueElement, XmlTag.class);
@@ -95,6 +119,12 @@ public static PhpClass getPhpClassOfServiceMethod(XmlElement psiMethodValueEleme
         return null;
     }
 
+    /**
+     * Get Php Class Of Job Method.
+     *
+     * @param psiMethodValueElement
+     * @return PhpClass
+     */
     @Nullable
     public static PhpClass getPhpClassOfJobMethod(XmlElement psiMethodValueElement) {
         XmlTag serviceTag = PsiTreeUtil.getParentOfType(psiMethodValueElement, XmlTag.class);
@@ -124,6 +154,13 @@ public static PhpClass getPhpClassOfJobMethod(XmlElement psiMethodValueElement)
         return null;
     }
 
+    /**
+     * Get Virtual Type Elements.
+     *
+     * @param name
+     * @param scope
+     * @return Collection<PsiElement>
+     */
     public Collection<PsiElement> getVirtualTypeElements(final String name, final GlobalSearchScope scope) {
         Collection<PsiElement> result = new ArrayList<>();
 
@@ -141,6 +178,13 @@ public Collection<PsiElement> getVirtualTypeElements(final String name, final Gl
         return result;
     }
 
+    /**
+     * Get All Virtual Type Element Names.
+     *
+     * @param prefixMatcher
+     * @param scope
+     * @return Collection<String>
+     */
     public Collection<String> getAllVirtualTypeElementNames(PrefixMatcher prefixMatcher, final GlobalSearchScope scope) {
         Collection<String> keys =
                 FileBasedIndex.getInstance().getAllKeys(VirtualTypeIndex.KEY, project);
@@ -149,6 +193,12 @@ public Collection<String> getAllVirtualTypeElementNames(PrefixMatcher prefixMatc
         return keys;
     }
 
+    /**
+     * Get Top Type Of Virtual Type.
+     *
+     * @param name
+     * @return String
+     */
     @NotNull
     private String getTopTypeOfVirtualType(@NotNull String name) {
         List<String> values;

src/com/magento/idea/magento2plugin/reference/provider/PhpJobMethodReferenceProvider.java

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.reference.provider;
 
 import com.intellij.openapi.util.text.StringUtil;
@@ -14,12 +15,16 @@
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.indexes.DiIndex;
 import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
-import org.jetbrains.annotations.NotNull;
-
+// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import org.jetbrains.annotations.NotNull;
 
+/**
+ * TODO: enable style checks after decomposition.
+ */
+@SuppressWarnings({"PMD", "checkstyle:all"})
 public class PhpJobMethodReferenceProvider extends PsiReferenceProvider {
 
     @NotNull