| /* |
| * Copyright 2008-2011 Bas Leijdekkers |
| * |
| * 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.migration; |
| |
| import com.intellij.codeInspection.ProblemDescriptor; |
| import com.intellij.openapi.project.Project; |
| import com.intellij.openapi.util.text.StringUtil; |
| import com.intellij.psi.*; |
| import com.intellij.psi.util.PsiUtil; |
| import com.intellij.util.IncorrectOperationException; |
| import com.siyeh.InspectionGadgetsBundle; |
| import com.siyeh.ig.BaseInspection; |
| import com.siyeh.ig.BaseInspectionVisitor; |
| import com.siyeh.ig.InspectionGadgetsFix; |
| import com.siyeh.ig.PsiReplacementUtil; |
| import com.siyeh.ig.psiutils.ExpectedTypeUtils; |
| import org.jetbrains.annotations.Nls; |
| import org.jetbrains.annotations.NonNls; |
| import org.jetbrains.annotations.NotNull; |
| import org.jetbrains.annotations.Nullable; |
| |
| public class CollectionsFieldAccessReplaceableByMethodCallInspection |
| extends BaseInspection { |
| |
| @Override |
| @Nls |
| @NotNull |
| public String getDisplayName() { |
| return InspectionGadgetsBundle.message( |
| "collections.field.access.replaceable.by.method.call.display.name"); |
| } |
| |
| @Override |
| @NotNull |
| protected String buildErrorString(Object... infos) { |
| return InspectionGadgetsBundle.message( |
| "collections.field.access.replaceable.by.method.call.problem.descriptor", |
| infos[1]); |
| } |
| |
| @Override |
| @Nullable |
| protected InspectionGadgetsFix buildFix(Object... infos) { |
| final PsiReferenceExpression expression = |
| (PsiReferenceExpression)infos[0]; |
| return new CollectionsFieldAccessReplaceableByMethodCallFix( |
| expression.getReferenceName()); |
| } |
| |
| private static class CollectionsFieldAccessReplaceableByMethodCallFix |
| extends InspectionGadgetsFix { |
| |
| private final String replacementText; |
| |
| private CollectionsFieldAccessReplaceableByMethodCallFix( |
| String referenceName) { |
| replacementText = getCollectionsMethodCallText(referenceName); |
| } |
| |
| @NotNull |
| @Override |
| public String getFamilyName() { |
| return "Replace Collections.EMPTY_* with call"; |
| } |
| |
| @Override |
| @NotNull |
| public String getName() { |
| return InspectionGadgetsBundle.message( |
| "collections.field.access.replaceable.by.method.call.quickfix", |
| replacementText); |
| } |
| |
| @NonNls |
| private static String getCollectionsMethodCallText( |
| PsiReferenceExpression referenceExpression) { |
| final String referenceName = referenceExpression.getReferenceName(); |
| final PsiElement parent = referenceExpression.getParent(); |
| if (!(parent instanceof PsiExpressionList)) { |
| return getUntypedCollectionsMethodCallText(referenceName); |
| } |
| final PsiType type = ExpectedTypeUtils.findExpectedType( |
| referenceExpression, false); |
| if (!(type instanceof PsiClassType)) { |
| return getUntypedCollectionsMethodCallText(referenceName); |
| } |
| final PsiClassType classType = (PsiClassType)type; |
| final PsiType[] parameterTypes = classType.getParameters(); |
| boolean useTypeParameter = false; |
| final String[] canonicalTexts = new String[parameterTypes.length]; |
| for (int i = 0, parameterTypesLength = parameterTypes.length; |
| i < parameterTypesLength; i++) { |
| final PsiType parameterType = parameterTypes[i]; |
| if (parameterType instanceof PsiWildcardType) { |
| final PsiWildcardType wildcardType = |
| (PsiWildcardType)parameterType; |
| final PsiType bound = wildcardType.getBound(); |
| if (bound != null) { |
| if (!bound.equalsToText( |
| CommonClassNames.JAVA_LANG_OBJECT)) { |
| useTypeParameter = true; |
| } |
| canonicalTexts[i] = bound.getCanonicalText(); |
| } |
| else { |
| canonicalTexts[i] = CommonClassNames.JAVA_LANG_OBJECT; |
| } |
| } |
| else { |
| if (!parameterType.equalsToText( |
| CommonClassNames.JAVA_LANG_OBJECT)) { |
| useTypeParameter = true; |
| } |
| canonicalTexts[i] = parameterType.getCanonicalText(); |
| } |
| } |
| if (useTypeParameter) { |
| return "Collections.<" + StringUtil.join(canonicalTexts, ",") + |
| '>' + getCollectionsMethodCallText(referenceName); |
| } |
| else { |
| return getUntypedCollectionsMethodCallText(referenceName); |
| } |
| } |
| |
| @NonNls |
| private static String getUntypedCollectionsMethodCallText( |
| String referenceName) { |
| return "Collections." + getCollectionsMethodCallText(referenceName); |
| } |
| |
| @NonNls |
| private static String getCollectionsMethodCallText( |
| @NonNls String referenceName) { |
| if ("EMPTY_LIST".equals(referenceName)) { |
| return "emptyList()"; |
| } |
| else if ("EMPTY_MAP".equals(referenceName)) { |
| return "emptyMap()"; |
| } |
| else if ("EMPTY_SET".equals(referenceName)) { |
| return "emptySet()"; |
| } |
| else { |
| throw new AssertionError("unknown collections field name: " + |
| referenceName); |
| } |
| } |
| |
| @Override |
| protected void doFix(Project project, ProblemDescriptor descriptor) |
| throws IncorrectOperationException { |
| final PsiElement element = descriptor.getPsiElement(); |
| if (!(element instanceof PsiReferenceExpression)) { |
| return; |
| } |
| final PsiReferenceExpression referenceExpression = |
| (PsiReferenceExpression)element; |
| final String newMethodCallText = |
| getCollectionsMethodCallText(referenceExpression); |
| PsiReplacementUtil.replaceExpression(referenceExpression, |
| "java.util." + newMethodCallText); |
| } |
| } |
| |
| @Override |
| public BaseInspectionVisitor buildVisitor() { |
| return new CollectionsFieldAccessReplaceableByMethodCallVisitor(); |
| } |
| |
| private static class CollectionsFieldAccessReplaceableByMethodCallVisitor |
| extends BaseInspectionVisitor { |
| |
| @Override |
| public void visitReferenceExpression( |
| PsiReferenceExpression expression) { |
| if (!PsiUtil.isLanguageLevel5OrHigher(expression)) { |
| return; |
| } |
| super.visitReferenceExpression(expression); |
| @NonNls final String name = expression.getReferenceName(); |
| @NonNls final String replacement; |
| if ("EMPTY_LIST".equals(name)) { |
| replacement = "emptyList()"; |
| } |
| else if ("EMPTY_MAP".equals(name)) { |
| replacement = "emptyMap()"; |
| } |
| else if ("EMPTY_SET".equals(name)) { |
| replacement = "emptySet()"; |
| } |
| else { |
| return; |
| } |
| final PsiElement target = expression.resolve(); |
| if (!(target instanceof PsiField)) { |
| return; |
| } |
| final PsiField field = (PsiField)target; |
| final PsiClass containingClass = field.getContainingClass(); |
| if (containingClass == null) { |
| return; |
| } |
| final String qualifiedName = containingClass.getQualifiedName(); |
| if (!CommonClassNames.JAVA_UTIL_COLLECTIONS.equals(qualifiedName)) { |
| return; |
| } |
| registerError(expression, expression, replacement); |
| } |
| } |
| } |