Merge pull request #322 from cedricziel/cleanups

Author: cedricziel

typo3-cms/src/main/java/com/cedricziel/idea/typo3/TYPO3DictionaryProvider.java

@@ -0,0 +1,10 @@
+package com.cedricziel.idea.typo3;
+
+import com.intellij.spellchecker.BundledDictionaryProvider;
+
+public class TYPO3DictionaryProvider implements BundledDictionaryProvider {
+    @Override
+    public String[] getBundledDictionaries() {
+        return new String[]{"typo3.dic"};
+    }
+}

typo3-cms/src/main/java/com/cedricziel/idea/typo3/action/ExtbaseControllerActionAction.java

@@ -70,7 +70,7 @@ public void update(AnActionEvent event) {
      * @param event Carries information on the invocation place
      */
     @Override
-    public void actionPerformed(AnActionEvent event) {
+    public void actionPerformed(@NotNull AnActionEvent event) {
         final Project project = getEventProject(event);
         if (project == null) {
             this.setStatus(event, false);
@@ -113,11 +113,10 @@ private void write(@NotNull Project project, PhpClass phpClass, String actionNam
 
             @Override
             protected void run(@NotNull Result result) {
-                final String methodName = actionName;
 
                 Method actionMethod = PhpPsiElementFactory.createMethod(
                         project,
-                        "public function " + methodName + " () { \n" +
+                        "public function " + actionName + " () { \n" +
                                 "}\n"
 
                 );
@@ -130,7 +129,7 @@ protected void run(@NotNull Result result) {
                 PsiDocumentManager.getInstance(project).doPostponedOperationsAndUnblockDocument(editor.getDocument());
                 PsiDocumentManager.getInstance(project).commitDocument(editor.getDocument());
 
-                final int insertPos = CodeUtil.getMethodInsertPosition(phpClass, methodName);
+                final int insertPos = CodeUtil.getMethodInsertPosition(phpClass, actionName);
                 if (insertPos == -1) {
                     return;
                 }
@@ -145,7 +144,7 @@ protected void run(@NotNull Result result) {
                 CodeStyleManager.getInstance(project).reformatText(phpClass.getContainingFile(), insertPos, endPos);
                 PsiDocumentManager.getInstance(project).commitDocument(editor.getDocument());
 
-                Method insertedMethod = phpClass.findMethodByName(methodName);
+                Method insertedMethod = phpClass.findMethodByName(actionName);
                 if (insertedMethod != null) {
                     editor.getCaretModel().moveToOffset(insertedMethod.getTextRange().getStartOffset());
                     editor.getScrollingModel().scrollToCaret(ScrollType.RELATIVE);

typo3-cms/src/main/java/com/cedricziel/idea/typo3/codeInsight/navigation/PathResourceGotoDeclarationHandler.java

@@ -39,7 +39,7 @@ private PsiElement[] emptyPsiElementArray() {
 
     @Nullable
     @Override
-    public String getActionText(DataContext context) {
+    public String getActionText(@NotNull DataContext context) {
         return null;
     }
 }

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);

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<>();

typo3-cms/src/main/java/com/cedricziel/idea/typo3/contextApi/ContextReferenceContributor.java

@@ -22,7 +22,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
         );
     }
 
-    private class ContextReferenceProvider extends PsiReferenceProvider {
+    private static class ContextReferenceProvider extends PsiReferenceProvider {
         @NotNull
         @Override
         public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {

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

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) {
 

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",
@@ -50,9 +50,7 @@ public static PhpClass getBaseRepositoryClass(@NotNull Project project) {
             return null;
         }
 
-        PhpClass repositoryClass = iterator.next();
-
-        return repositoryClass;
+        return iterator.next();
     }
 
     public static boolean isRepositoryClass(@NotNull PhpClass phpClass) {

typo3-cms/src/main/java/com/cedricziel/idea/typo3/extbase/persistence/ExtbaseModelCollectionReturnTypeProvider.java

@@ -13,6 +13,7 @@
 import com.jetbrains.php.lang.psi.resolve.types.PhpType;
 import com.jetbrains.php.lang.psi.resolve.types.PhpTypeProvider4;
 import org.apache.commons.lang.StringUtils;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
@@ -180,7 +181,7 @@ public MethodReturnTypeVisitor() {
         }
 
         @Override
-        public void visitElement(PsiElement element) {
+        public void visitElement(@NotNull PsiElement element) {
             super.visitElement(element);
 
             if (PlatformPatterns.psiElement(FieldReference.class).withParent(PhpReturn.class).accepts(element)) {