[T3CMS] Apply cleanups

cedricziel · cedricziel · commit 0f50b624be37 · 2020-05-02T12:32:27.000+02:00
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/codeInspection/quickfix/CreateInjectorQuickFix.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/codeInspection/quickfix/CreateInjectorQuickFix.java
@@ -30,7 +30,7 @@
 
 public class CreateInjectorQuickFix implements LocalQuickFix {
 
-    private SmartPsiElementPointer element;
+    private final SmartPsiElementPointer<PhpDocTag> element;
 
     public CreateInjectorQuickFix(@NotNull PhpDocTag element) {
         this.element = SmartPointerManager.getInstance(element.getProject()).createSmartPsiElementPointer(element);
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/container/CoreServiceParser.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/container/CoreServiceParser.java
@@ -19,7 +19,7 @@
  */
 public class CoreServiceParser {
 
-    private HashMap<String, ArrayList<TYPO3ServiceDefinition>> serviceMap;
+    private final HashMap<String, ArrayList<TYPO3ServiceDefinition>> serviceMap;
 
     public CoreServiceParser() {
         this.serviceMap = new HashMap<>();
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/domain/TYPO3ServiceDefinition.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/domain/TYPO3ServiceDefinition.java
@@ -3,6 +3,7 @@
 import org.jetbrains.annotations.NotNull;
 
 import java.io.Serializable;
+import java.util.Objects;
 
 public class TYPO3ServiceDefinition implements Serializable {
 
@@ -129,18 +130,18 @@ public boolean equals(Object o) {
         TYPO3ServiceDefinition that = (TYPO3ServiceDefinition) o;
 
         if (!id.equals(that.id)) return false;
-        if (extensionName != null ? !extensionName.equals(that.extensionName) : that.extensionName != null)
+        if (!Objects.equals(extensionName, that.extensionName))
             return false;
-        if (className != null ? !className.equals(that.className) : that.className != null) return false;
-        if (title != null ? !title.equals(that.title) : that.title != null) return false;
-        if (description != null ? !description.equals(that.description) : that.description != null) return false;
-        if (subType != null ? !subType.equals(that.subType) : that.subType != null) return false;
-        if (available != null ? !available.equals(that.available) : that.available != null) return false;
-        if (priority != null ? !priority.equals(that.priority) : that.priority != null) return false;
-        if (quality != null ? !quality.equals(that.quality) : that.quality != null) return false;
-        if (os != null ? !os.equals(that.os) : that.os != null) return false;
-        if (exec != null ? !exec.equals(that.exec) : that.exec != null) return false;
-        return signature != null ? signature.equals(that.signature) : that.signature == null;
+        if (!Objects.equals(className, that.className)) return false;
+        if (!Objects.equals(title, that.title)) return false;
+        if (!Objects.equals(description, that.description)) return false;
+        if (!Objects.equals(subType, that.subType)) return false;
+        if (!Objects.equals(available, that.available)) return false;
+        if (!Objects.equals(priority, that.priority)) return false;
+        if (!Objects.equals(quality, that.quality)) return false;
+        if (!Objects.equals(os, that.os)) return false;
+        if (!Objects.equals(exec, that.exec)) return false;
+        return Objects.equals(signature, that.signature);
     }
 
     @Override
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/domain/factory/ExtensionDefinitionFactory.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/domain/factory/ExtensionDefinitionFactory.java
@@ -134,7 +134,7 @@ private static boolean isValidPackageType(String composerPackageType) {
      * Guesses an extension key from the composer package name.
      *
      * @param packageName The package name to analyze
-     * @return
+     * @return The extension key
      */
     private static String extensionKeyFromPackageName(String packageName) {
 
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/extbase/ExtbaseUtils.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/extbase/ExtbaseUtils.java
@@ -18,9 +18,9 @@
 public class ExtbaseUtils {
     public static final String EXTBASE_ABSTRACT_ENTITY_FQN = "TYPO3\\CMS\\Extbase\\DomainObject\\AbstractEntity";
 
-    public static String EXTBASE_QUERY_INTERFACE_FQN = "TYPO3\\CMS\\Extbase\\Persistence\\QueryInterface";
+    public static final String EXTBASE_QUERY_INTERFACE_FQN = "TYPO3\\CMS\\Extbase\\Persistence\\QueryInterface";
 
-    public static String[] EXTBASE_QUERY_BUILDER_METHODS = {
+    public static final String[] EXTBASE_QUERY_BUILDER_METHODS = {
             "equals",
             "like",
             "contains",
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/icons/IconStub.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/icons/IconStub.java
@@ -4,6 +4,7 @@
 import com.intellij.psi.PsiElement;
 
 import java.io.Serializable;
+import java.util.Objects;
 
 public class IconStub implements IconInterface, Serializable {
 
@@ -77,10 +78,10 @@ public boolean equals(Object o) {
         IconStub iconStub = (IconStub) o;
 
         if (!identifier.equals(iconStub.identifier)) return false;
-        if (extension != null ? !extension.equals(iconStub.extension) : iconStub.extension != null) return false;
-        if (filename != null ? !filename.equals(iconStub.filename) : iconStub.filename != null) return false;
-        if (provider != null ? !provider.equals(iconStub.provider) : iconStub.provider != null) return false;
-        if (source != null ? !source.equals(iconStub.source) : iconStub.source != null) return false;
+        if (!Objects.equals(extension, iconStub.extension)) return false;
+        if (!Objects.equals(filename, iconStub.filename)) return false;
+        if (!Objects.equals(provider, iconStub.provider)) return false;
+        if (!Objects.equals(source, iconStub.source)) return false;
         return textRange.equals(iconStub.textRange);
     }
 
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/index/ExtensionNameStubIndex.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/index/ExtensionNameStubIndex.java
@@ -13,7 +13,7 @@
 
 public class ExtensionNameStubIndex extends FileBasedIndexExtension<String, String> {
 
-    private static ObjectStreamDataExternalizer<String> EXTERNALIZER = new ObjectStreamDataExternalizer<>();
+    private static final ObjectStreamDataExternalizer<String> EXTERNALIZER = new ObjectStreamDataExternalizer<>();
 
     public static final ID<String, String> KEY = ID.create("com.cedricziel.idea.typo3.index.extension_name");
 
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/index/extbase/ControllerActionIndex.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/index/extbase/ControllerActionIndex.java
@@ -2,6 +2,7 @@
 
 import com.cedricziel.idea.typo3.extbase.controller.StubControllerAction;
 import com.cedricziel.idea.typo3.index.externalizer.ObjectStreamDataExternalizer;
+import com.cedricziel.idea.typo3.util.ExtbaseUtility;
 import com.cedricziel.idea.typo3.util.ExtensionUtility;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiRecursiveElementVisitor;
@@ -15,13 +16,11 @@
 import gnu.trove.THashMap;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Map;
 
 public class ControllerActionIndex extends FileBasedIndexExtension<String, StubControllerAction> {
 
-    public static ID<String, StubControllerAction> KEY = ID.create("com.cedricziel.idea.typo3.extbase.controller_action");
+    public static final ID<String, StubControllerAction> KEY = ID.create("com.cedricziel.idea.typo3.extbase.controller_action");
 
     @NotNull
     @Override
@@ -78,7 +77,7 @@ public boolean dependsOnFileContent() {
     }
 
     static class ControllerActionRecursiveVisitor extends PsiRecursiveElementVisitor {
-        Map<String, StubControllerAction> map;
+        final Map<String, StubControllerAction> map;
 
         ControllerActionRecursiveVisitor() {
             this.map = new THashMap<>();
@@ -106,7 +105,7 @@ public void visitElement(@NotNull PsiElement element) {
                     return;
                 }
 
-                if (!isActionController(containingClass)) {
+                if (!ExtbaseUtility.isActionController(containingClass)) {
                     super.visitElement(element);
 
                     return;
@@ -123,15 +122,5 @@ public void visitElement(@NotNull PsiElement element) {
 
             super.visitElement(element);
         }
-
-        private boolean isActionController(@NotNull PhpClass containingClass) {
-            List<String> fqns = new ArrayList<>();
-
-            if (containingClass.getSuperFQN() != null) {
-                fqns.add(containingClass.getSuperFQN());
-            }
-
-            return fqns.contains("\\TYPO3\\CMS\\Extbase\\Mvc\\Controller\\ActionController");
-        }
     }
 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/psi/visitor/CoreIconParserVisitor.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/psi/visitor/CoreIconParserVisitor.java
@@ -14,7 +14,7 @@
  */
 public class CoreIconParserVisitor extends PsiRecursiveElementVisitor {
 
-    private Map<String, IconStub> map;
+    private final Map<String, IconStub> map;
 
     public CoreIconParserVisitor() {
         this.map = new HashMap<>();
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/psi/visitor/CoreServiceDefinitionParserVisitor.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/psi/visitor/CoreServiceDefinitionParserVisitor.java
@@ -16,7 +16,7 @@
  */
 public class CoreServiceDefinitionParserVisitor extends PsiRecursiveElementVisitor {
 
-    private Map<String, ArrayList<TYPO3ServiceDefinition>> map;
+    private final Map<String, ArrayList<TYPO3ServiceDefinition>> map;
 
     public CoreServiceDefinitionParserVisitor(Map<String, ArrayList<TYPO3ServiceDefinition>> map) {
         this.map = map;
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/resources/ResourceReference.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/resources/ResourceReference.java
@@ -24,29 +24,12 @@ public ResourceReference(YAMLQuotedText psiElement) {
         this.resourceName = psiElement.getTextValue();
     }
 
-    /**
-     * Returns the results of resolving the reference.
-     *
-     * @param incompleteCode if true, the code in the context of which the reference is
-     *                       being resolved is considered incomplete, and the method may return additional
-     *                       invalid results.
-     * @return the array of results for resolving the reference.
-     */
     @NotNull
     @Override
     public ResolveResult[] multiResolve(boolean incompleteCode) {
         return PsiElementResolveResult.createResults(ResourceUtil.getResourceDefinitionElements(myElement.getProject(), resourceName));
     }
 
-    /**
-     * Returns the array of String, {@link PsiElement} and/or {@link LookupElement}
-     * instances representing all identifiers that are visible at the location of the reference. The contents
-     * of the returned array is used to build the lookup list for basic code completion. (The list
-     * of visible identifiers may not be filtered by the completion prefix string - the
-     * filtering is performed later by IDEA core.)
-     *
-     * @return the array of available identifiers.
-     */
     @NotNull
     @Override
     public Object[] getVariants() {
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/tca/TableReference.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/tca/TableReference.java
@@ -19,29 +19,12 @@ public TableReference(@NotNull StringLiteralExpression element) {
         this.tablename = element.getContents();
     }
 
-    /**
-     * Returns the results of resolving the reference.
-     *
-     * @param incompleteCode if true, the code in the context of which the reference is
-     *                       being resolved is considered incomplete, and the method may return additional
-     *                       invalid results.
-     * @return the array of results for resolving the reference.
-     */
     @NotNull
     @Override
     public ResolveResult[] multiResolve(boolean incompleteCode) {
         return PsiElementResolveResult.createResults(getTableDefinitionElements(tablename, myElement.getProject()));
     }
 
-    /**
-     * Returns the array of String, {@link PsiElement} and/or {@link LookupElement}
-     * instances representing all identifiers that are visible at the location of the reference. The contents
-     * of the returned array is used to build the lookup list for basic code completion. (The list
-     * of visible identifiers may not be filtered by the completion prefix string - the
-     * filtering is performed later by IDEA core.)
-     *
-     * @return the array of available identifiers.
-     */
     @NotNull
     @Override
     public Object[] getVariants() {
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/userFunc/UserFuncReference.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/userFunc/UserFuncReference.java
@@ -14,7 +14,6 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.Iterator;
 import java.util.List;
 
 public class UserFuncReference extends PsiPolyVariantReferenceBase<PsiElement> {
@@ -130,19 +129,12 @@ public Object[] getVariants() {
         PhpIndex phpIndex = PhpIndex.getInstance(myElement.getProject());
 
         if (className == null) {
-            Iterator<String> globalFunctions = phpIndex.getAllFunctionNames(null).iterator();
-            while (true) {
-                while (globalFunctions.hasNext()) {
-                    String functionName = globalFunctions.next();
-
-                    phpIndex
-                            .getFunctionsByName(functionName)
-                            .stream()
-                            .map(UserFuncLookupElement::new)
-                            .forEach(list::add);
-                }
-
-                break;
+            for (String functionName : phpIndex.getAllFunctionNames(null)) {
+                phpIndex
+                    .getFunctionsByName(functionName)
+                    .stream()
+                    .map(UserFuncLookupElement::new)
+                    .forEach(list::add);
             }
         }
 
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/ExtbaseUtility.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/ExtbaseUtility.java
@@ -1,10 +1,27 @@
 package com.cedricziel.idea.typo3.util;
 
+import com.jetbrains.php.lang.psi.elements.PhpClass;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.ArrayList;
+import java.util.List;
+
 public class ExtbaseUtility {
+
+    public static final String CONTROLLER_BASE_CLASS = "\\TYPO3\\CMS\\Extbase\\Mvc\\Controller\\ActionController";
+
     public static String convertRepositoryFQNToEntityFQN(@NotNull String repositoryClassFQN) {
         return StringUtils.stripStart(StringUtils.replace(StringUtils.replace(repositoryClassFQN, "\\Domain\\Repository", "\\Domain\\Model"), "Repository", ""), "\\");
     }
+
+    public static boolean isActionController(@NotNull PhpClass containingClass) {
+        List<String> fqns = new ArrayList<>();
+
+        if (containingClass.getSuperFQN() != null) {
+            fqns.add(containingClass.getSuperFQN());
+        }
+
+        return fqns.contains(CONTROLLER_BASE_CLASS);
+    }
 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/PhpLangUtil.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/PhpLangUtil.java
@@ -98,7 +98,8 @@ public static String getClassName(@NotNull PsiElement element) {
         }
 
         Variable variableBeingCalledOn = PsiTreeUtil.findChildOfType(methodReference, Variable.class);
-        if (variableBeingCalledOn != null && variableBeingCalledOn.getInferredType() != null) {
+        if (variableBeingCalledOn != null) {
+            variableBeingCalledOn.getInferredType();
             PhpType inferredType = variableBeingCalledOn.getInferredType();
             return inferredType.toString();
         }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/ResourceUtil.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/ResourceUtil.java
@@ -8,9 +8,6 @@
 import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.ArrayList;
-import java.util.List;
-
 public class ResourceUtil {
     public static boolean isExtResourcePath(PsiElement element) {
         // must be a string element
@@ -33,11 +30,9 @@ public static PsiElement[] getResourceDefinitionElements(@NotNull Project projec
 
     public static Object[] getResourceLookupElements(@NotNull Project project) {
 
-        List<ResourceLookupElement> result = new ArrayList<>();
-        ResourcePathIndex.getAvailableExtensionResourceFiles(project).forEach(identifier -> {
-            result.add(new ResourceLookupElement(identifier));
-        });
-
-        return result.toArray();
+        return ResourcePathIndex.getAvailableExtensionResourceFiles(project)
+            .stream()
+            .map(ResourceLookupElement::new)
+            .toArray();
     }
 }
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/Slugify.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/Slugify.java
@@ -16,7 +16,7 @@ public class Slugify {
 	private final static Pattern PATTERN_NORMALIZE_SEPARATOR = Pattern.compile("[\\W\\s+]+");
 	private final static Pattern PATTERN_NORMALIZE_TRIM_DASH = Pattern.compile("^-|-$");
 
-	private final Map<String, String> customReplacements = new HashMap<String, String>();
+	private final Map<String, String> customReplacements = new HashMap<>();
 
 	private boolean underscoreSeparator = false;
 	private boolean lowerCase = true;
diff --git a/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/TCAUtil.java b/typo3-cms/src/main/java/com/cedricziel/idea/typo3/util/TCAUtil.java
@@ -211,7 +211,7 @@ public class TCAUtil {
     private static final String EXT_LOCALCONF_FILENAME = "ext_localconf.php";
     private static final String NODE_FACTORY_CLASS = "TYPO3\\CMS\\Backend\\Form\\NodeFactory";
 
-    private static Key<CachedValue<Set<String>>> RENDER_TYPES_KEY = new Key<>("TYPO3_CMS_RENDER_TYPES");
+    private static final Key<CachedValue<Set<String>>> RENDER_TYPES_KEY = new Key<>("TYPO3_CMS_RENDER_TYPES");
 
     public static boolean arrayIndexIsTCATableNameField(PsiElement element) {
         String arrayIndex = extractArrayIndexFromValue(element);

Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ private static boolean isValidPackageType(String composerPackageType) {`
`134`	`134`	`* Guesses an extension key from the composer package name.`
`135`	`135`	`*`
`136`	`136`	`* @param packageName The package name to analyze`
`137`		`- * @return`
	`137`	`+ * @return The extension key`
`138`	`138`	`*/`
`139`	`139`	`private static String extensionKeyFromPackageName(String packageName) {`
`140`	`140`