moved to analysis

2026-09-27 10:03:11 +07:00 · 2013-10-10 17:44:45 +04:00
parent 1ea667f010
commit ef37a6c455
2 changed files with 213 additions and 183 deletions
@@ -0,0 +1,211 @@
+/*
+ * Copyright 2000-2013 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.siyeh.ig.classlayout;
+
+import com.intellij.codeInsight.AnnotationUtil;
+import com.intellij.codeInspection.ProblemDescriptor;
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.ui.Messages;
+import com.intellij.psi.*;
+import com.intellij.psi.codeStyle.CodeStyleManager;
+import com.intellij.psi.search.GlobalSearchScope;
+import com.intellij.psi.search.SearchScope;
+import com.intellij.psi.search.searches.ClassInheritorsSearch;
+import com.intellij.psi.search.searches.ReferencesSearch;
+import com.intellij.util.IncorrectOperationException;
+import com.intellij.util.Query;
+import com.siyeh.HardcodedMethodConstants;
+import com.siyeh.InspectionGadgetsBundle;
+import com.siyeh.ig.BaseInspection;
+import com.siyeh.ig.BaseInspectionVisitor;
+import com.siyeh.ig.InspectionGadgetsFix;
+import com.siyeh.ig.psiutils.UtilityClassUtil;
+import com.siyeh.ig.ui.ExternalizableStringSet;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import javax.swing.*;
+
+public class UtilityClassWithoutPrivateConstructorInspectionBase extends BaseInspection {
+  @SuppressWarnings({"PublicField"})
+  public final ExternalizableStringSet ignorableAnnotations = new ExternalizableStringSet();
+  @SuppressWarnings({"PublicField"})
+  public boolean ignoreClassesWithOnlyMain = false;
+
+  @Nullable
+  static PsiMethod getNullArgConstructor(PsiClass aClass) {
+    final PsiMethod[] constructors = aClass.getConstructors();
+    for (final PsiMethod constructor : constructors) {
+      final PsiParameterList params = constructor.getParameterList();
+      if (params.getParametersCount() == 0) {
+        return constructor;
+      }
+    }
+    return null;
+  }
+
+  @Override
+  @NotNull
+  public String getDisplayName() {
+    return InspectionGadgetsBundle.message("utility.class.without.private.constructor.display.name");
+  }
+
+  @Override
+  @NotNull
+  protected String buildErrorString(Object... infos) {
+    return InspectionGadgetsBundle.message("utility.class.without.private.constructor.problem.descriptor");
+  }
+
+  @Override
+  public BaseInspectionVisitor buildVisitor() {
+    return new UtilityClassWithoutPrivateConstructorVisitor();
+  }
+
+  protected static class CreateEmptyPrivateConstructor extends InspectionGadgetsFix {
+
+    @Override
+    @NotNull
+    public String getName() {
+      return InspectionGadgetsBundle.message("utility.class.without.private.constructor.create.quickfix");
+    }
+
+    @NotNull
+    @Override
+    public String getFamilyName() {
+      return getName();
+    }
+
+    @Override
+    public void doFix(Project project, ProblemDescriptor descriptor) throws IncorrectOperationException {
+      final PsiElement classNameIdentifier = descriptor.getPsiElement();
+      final PsiElement parent = classNameIdentifier.getParent();
+      if (!(parent instanceof PsiClass)) {
+        return;
+      }
+      final PsiClass aClass = (PsiClass)parent;
+      final Query<PsiReference> query = ReferencesSearch.search(aClass, aClass.getUseScope());
+      for (PsiReference reference : query) {
+        if (reference == null) {
+          continue;
+        }
+        final PsiElement element = reference.getElement();
+        final PsiElement context = element.getParent();
+        if (context instanceof PsiNewExpression) {
+          SwingUtilities.invokeLater(new Runnable() {
+            @Override
+            public void run() {
+              Messages.showInfoMessage(aClass.getProject(),
+                                       "Utility class has instantiations, private constructor will not be created",
+                                       "Can't generate constructor");
+            }
+          });
+          return;
+        }
+      }
+      final JavaPsiFacade psiFacade = JavaPsiFacade.getInstance(project);
+      final PsiElementFactory factory = psiFacade.getElementFactory();
+      final PsiMethod constructor = factory.createConstructor();
+      final PsiModifierList modifierList = constructor.getModifierList();
+      modifierList.setModifierProperty(PsiModifier.PRIVATE, true);
+      aClass.add(constructor);
+      final CodeStyleManager styleManager = CodeStyleManager.getInstance(project);
+      styleManager.reformat(constructor);
+    }
+  }
+
+  private class UtilityClassWithoutPrivateConstructorVisitor extends BaseInspectionVisitor {
+
+    @Override
+    public void visitClass(@NotNull PsiClass aClass) {
+      // no call to super, so that it doesn't drill down to inner classes
+      if (aClass.hasModifierProperty(PsiModifier.ABSTRACT)) {
+        return;
+      }
+      if (!UtilityClassUtil.isUtilityClass(aClass)) {
+        return;
+      }
+      if (ignoreClassesWithOnlyMain && hasOnlyMain(aClass)) {
+        return;
+      }
+      if (hasPrivateConstructor(aClass)) {
+        return;
+      }
+      if (AnnotationUtil.isAnnotated(aClass, ignorableAnnotations)) {
+        return;
+      }
+      if (aClass.hasModifierProperty(PsiModifier.PRIVATE) && aClass.getConstructors().length == 0) {
+        return;
+      }
+      final SearchScope scope = GlobalSearchScope.projectScope(aClass.getProject());
+      final Query<PsiClass> query = ClassInheritorsSearch.search(aClass, scope, true, true);
+      final PsiClass subclass = query.findFirst();
+      if (subclass != null) {
+        return;
+      }
+      registerClassError(aClass, aClass);
+    }
+
+    private boolean hasOnlyMain(PsiClass aClass) {
+      final PsiMethod[] methods = aClass.getMethods();
+      if (methods.length == 0) {
+        return false;
+      }
+      for (PsiMethod method : methods) {
+        if (method.isConstructor()) {
+          continue;
+        }
+        if (!method.hasModifierProperty(PsiModifier.STATIC)) {
+          return false;
+        }
+        if (method.hasModifierProperty(PsiModifier.PRIVATE)) {
+          continue;
+        }
+        if (!method.hasModifierProperty(PsiModifier.PUBLIC)) {
+          return false;
+        }
+        final String name = method.getName();
+        if (!name.equals(HardcodedMethodConstants.MAIN)) {
+          return false;
+        }
+        final PsiType returnType = method.getReturnType();
+        if (!PsiType.VOID.equals(returnType)) {
+          return false;
+        }
+        final PsiParameterList parameterList = method.getParameterList();
+        if (parameterList.getParametersCount() != 1) {
+          return false;
+        }
+        final PsiParameter[] parameters = parameterList.getParameters();
+        final PsiParameter parameter = parameters[0];
+        final PsiType type = parameter.getType();
+        if (!type.equalsToText("java.lang.String[]")) {
+          return false;
+        }
+      }
+      return true;
+    }
+
+    boolean hasPrivateConstructor(PsiClass aClass) {
+      final PsiMethod[] constructors = aClass.getConstructors();
+      for (final PsiMethod constructor : constructors) {
+        if (constructor.hasModifierProperty(PsiModifier.PRIVATE)) {
+          return true;
+        }
+      }
+      return false;
+    }
+  }
+}
@@ -15,28 +15,17 @@
 */
 package com.siyeh.ig.classlayout;

-import com.intellij.codeInsight.AnnotationUtil;
 import com.intellij.codeInspection.ProblemDescriptor;
 import com.intellij.codeInspection.util.SpecialAnnotationsUtil;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.ui.Messages;
 import com.intellij.psi.*;
-import com.intellij.psi.codeStyle.CodeStyleManager;
-import com.intellij.psi.search.GlobalSearchScope;
-import com.intellij.psi.search.SearchScope;
-import com.intellij.psi.search.searches.ClassInheritorsSearch;
 import com.intellij.psi.search.searches.ReferencesSearch;
 import com.intellij.util.IncorrectOperationException;
 import com.intellij.util.Query;
 import com.intellij.util.ui.CheckBox;
-import com.siyeh.HardcodedMethodConstants;
 import com.siyeh.InspectionGadgetsBundle;
-import com.siyeh.ig.BaseInspection;
-import com.siyeh.ig.BaseInspectionVisitor;
 import com.siyeh.ig.InspectionGadgetsFix;
 import com.siyeh.ig.fixes.AddToIgnoreIfAnnotatedByListQuickFix;
-import com.siyeh.ig.psiutils.UtilityClassUtil;
-import com.siyeh.ig.ui.ExternalizableStringSet;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;

@@ -45,25 +34,7 @@ import java.awt.*;
 import java.util.ArrayList;
 import java.util.List;

-public class UtilityClassWithoutPrivateConstructorInspection extends BaseInspection {
-
-  @SuppressWarnings({"PublicField"})
-  public boolean ignoreClassesWithOnlyMain = false;
-
-  @SuppressWarnings({"PublicField"})
-  public final ExternalizableStringSet ignorableAnnotations = new ExternalizableStringSet();
-
-  @Override
-  @NotNull
-  public String getDisplayName() {
-    return InspectionGadgetsBundle.message("utility.class.without.private.constructor.display.name");
-  }
-
-  @Override
-  @NotNull
-  protected String buildErrorString(Object... infos) {
-    return InspectionGadgetsBundle.message("utility.class.without.private.constructor.problem.descriptor");
-  }
+public class UtilityClassWithoutPrivateConstructorInspection extends UtilityClassWithoutPrivateConstructorInspectionBase {

  @Override
  @Nullable
@@ -81,7 +52,7 @@ public class UtilityClassWithoutPrivateConstructorInspection extends BaseInspect
  @NotNull
  @Override
  protected InspectionGadgetsFix[] buildFixes(Object... infos) {
-    final List<InspectionGadgetsFix> fixes = new ArrayList();
+    final List<InspectionGadgetsFix> fixes = new ArrayList<InspectionGadgetsFix>();
    final PsiClass aClass = (PsiClass)infos[0];
    final PsiMethod constructor = getNullArgConstructor(aClass);
    if (constructor == null) {
@@ -98,58 +69,6 @@ public class UtilityClassWithoutPrivateConstructorInspection extends BaseInspect
    return fixes.toArray(new InspectionGadgetsFix[fixes.size()]);
  }

-  private static class CreateEmptyPrivateConstructor extends InspectionGadgetsFix {
-
-    @Override
-    @NotNull
-    public String getName() {
-      return InspectionGadgetsBundle.message("utility.class.without.private.constructor.create.quickfix");
-    }
-
-    @NotNull
-    @Override
-    public String getFamilyName() {
-      return getName();
-    }
-
-    @Override
-    public void doFix(Project project, ProblemDescriptor descriptor) throws IncorrectOperationException {
-      final PsiElement classNameIdentifier = descriptor.getPsiElement();
-      final PsiElement parent = classNameIdentifier.getParent();
-      if (!(parent instanceof PsiClass)) {
-        return;
-      }
-      final PsiClass aClass = (PsiClass)parent;
-      final Query<PsiReference> query = ReferencesSearch.search(aClass, aClass.getUseScope());
-      for (PsiReference reference : query) {
-        if (reference == null) {
-          continue;
-        }
-        final PsiElement element = reference.getElement();
-        final PsiElement context = element.getParent();
-        if (context instanceof PsiNewExpression) {
-          SwingUtilities.invokeLater(new Runnable() {
-            @Override
-            public void run() {
-              Messages.showInfoMessage(aClass.getProject(),
-                                       "Utility class has instantiations, private constructor will not be created",
-                                       "Can't generate constructor");
-            }
-          });
-          return;
-        }
-      }
-      final JavaPsiFacade psiFacade = JavaPsiFacade.getInstance(project);
-      final PsiElementFactory factory = psiFacade.getElementFactory();
-      final PsiMethod constructor = factory.createConstructor();
-      final PsiModifierList modifierList = constructor.getModifierList();
-      modifierList.setModifierProperty(PsiModifier.PRIVATE, true);
-      aClass.add(constructor);
-      final CodeStyleManager styleManager = CodeStyleManager.getInstance(project);
-      styleManager.reformat(constructor);
-    }
-  }
-
  private static class MakeConstructorPrivateFix extends InspectionGadgetsFix {
    @Override
    @NotNull
@@ -183,104 +102,4 @@ public class UtilityClassWithoutPrivateConstructorInspection extends BaseInspect
      }
    }
  }
-
-  @Override
-  public BaseInspectionVisitor buildVisitor() {
-    return new UtilityClassWithoutPrivateConstructorVisitor();
-  }
-
-  private class UtilityClassWithoutPrivateConstructorVisitor extends BaseInspectionVisitor {
-
-    @Override
-    public void visitClass(@NotNull PsiClass aClass) {
-      // no call to super, so that it doesn't drill down to inner classes
-      if (aClass.hasModifierProperty(PsiModifier.ABSTRACT)) {
-        return;
-      }
-      if (!UtilityClassUtil.isUtilityClass(aClass)) {
-        return;
-      }
-      if (ignoreClassesWithOnlyMain && hasOnlyMain(aClass)) {
-        return;
-      }
-      if (hasPrivateConstructor(aClass)) {
-        return;
-      }
-      if (AnnotationUtil.isAnnotated(aClass, ignorableAnnotations)) {
-        return;
-      }
-      if (aClass.hasModifierProperty(PsiModifier.PRIVATE) && aClass.getConstructors().length == 0) {
-        return;
-      }
-      final SearchScope scope = GlobalSearchScope.projectScope(aClass.getProject());
-      final Query<PsiClass> query = ClassInheritorsSearch.search(aClass, scope, true, true);
-      final PsiClass subclass = query.findFirst();
-      if (subclass != null) {
-        return;
-      }
-      registerClassError(aClass, aClass);
-    }
-
-    private boolean hasOnlyMain(PsiClass aClass) {
-      final PsiMethod[] methods = aClass.getMethods();
-      if (methods.length == 0) {
-        return false;
-      }
-      for (PsiMethod method : methods) {
-        if (method.isConstructor()) {
-          continue;
-        }
-        if (!method.hasModifierProperty(PsiModifier.STATIC)) {
-          return false;
-        }
-        if (method.hasModifierProperty(PsiModifier.PRIVATE)) {
-          continue;
-        }
-        if (!method.hasModifierProperty(PsiModifier.PUBLIC)) {
-          return false;
-        }
-        final String name = method.getName();
-        if (!name.equals(HardcodedMethodConstants.MAIN)) {
-          return false;
-        }
-        final PsiType returnType = method.getReturnType();
-        if (!PsiType.VOID.equals(returnType)) {
-          return false;
-        }
-        final PsiParameterList parameterList = method.getParameterList();
-        if (parameterList.getParametersCount() != 1) {
-          return false;
-        }
-        final PsiParameter[] parameters = parameterList.getParameters();
-        final PsiParameter parameter = parameters[0];
-        final PsiType type = parameter.getType();
-        if (!type.equalsToText("java.lang.String[]")) {
-          return false;
-        }
-      }
-      return true;
-    }
-
-    boolean hasPrivateConstructor(PsiClass aClass) {
-      final PsiMethod[] constructors = aClass.getConstructors();
-      for (final PsiMethod constructor : constructors) {
-        if (constructor.hasModifierProperty(PsiModifier.PRIVATE)) {
-          return true;
-        }
-      }
-      return false;
-    }
-  }
-
-  @Nullable
-  static PsiMethod getNullArgConstructor(PsiClass aClass) {
-    final PsiMethod[] constructors = aClass.getConstructors();
-    for (final PsiMethod constructor : constructors) {
-      final PsiParameterList params = constructor.getParameterList();
-      if (params.getParametersCount() == 0) {
-        return constructor;
-      }
-    }
-    return null;
-  }
 }