| /* |
| * 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.naming; |
| |
| import com.intellij.psi.PsiClass; |
| import com.intellij.psi.PsiMethod; |
| import com.intellij.psi.PsiParameter; |
| import com.intellij.psi.PsiParameterList; |
| import com.intellij.psi.search.searches.SuperMethodsSearch; |
| import com.intellij.psi.util.MethodSignatureBackedByPsiMethod; |
| import com.intellij.util.Query; |
| import com.siyeh.InspectionGadgetsBundle; |
| import com.siyeh.ig.BaseInspection; |
| import com.siyeh.ig.BaseInspectionVisitor; |
| import com.siyeh.ig.psiutils.LibraryUtil; |
| import org.jetbrains.annotations.NotNull; |
| |
| public class ParameterNameDiffersFromOverriddenParameterInspectionBase extends BaseInspection { |
| /** |
| * @noinspection PublicField |
| */ |
| public boolean m_ignoreSingleCharacterNames = false; |
| /** |
| * @noinspection PublicField |
| */ |
| public boolean m_ignoreOverridesOfLibraryMethods = false; |
| |
| @Override |
| @NotNull |
| public String getDisplayName() { |
| return InspectionGadgetsBundle.message( |
| "parameter.name.differs.from.overridden.parameter.display.name"); |
| } |
| |
| @Override |
| @NotNull |
| public String buildErrorString(Object... infos) { |
| return InspectionGadgetsBundle.message( |
| "parameter.name.differs.from.overridden.parameter.problem.descriptor", |
| infos[0]); |
| } |
| |
| @Override |
| public BaseInspectionVisitor buildVisitor() { |
| return new ParameterNameDiffersFromOverriddenParameterVisitor(); |
| } |
| |
| private class ParameterNameDiffersFromOverriddenParameterVisitor |
| extends BaseInspectionVisitor { |
| |
| @Override |
| public void visitMethod(@NotNull PsiMethod method) { |
| final PsiParameterList parameterList = method.getParameterList(); |
| if (parameterList.getParametersCount() == 0) { |
| return; |
| } |
| final Query<MethodSignatureBackedByPsiMethod> query = |
| SuperMethodsSearch.search( |
| method, method.getContainingClass(), true, false); |
| final MethodSignatureBackedByPsiMethod methodSignature = |
| query.findFirst(); |
| if (methodSignature == null) { |
| return; |
| } |
| final PsiMethod superMethod = methodSignature.getMethod(); |
| final PsiParameter[] parameters = parameterList.getParameters(); |
| checkParameters(superMethod, parameters); |
| } |
| |
| private void checkParameters(PsiMethod superMethod, |
| PsiParameter[] parameters) { |
| if (m_ignoreOverridesOfLibraryMethods) { |
| final PsiClass containingClass = |
| superMethod.getContainingClass(); |
| if (containingClass != null && |
| LibraryUtil.classIsInLibrary(containingClass)) { |
| return; |
| } |
| } |
| final PsiParameterList superParameterList = |
| superMethod.getParameterList(); |
| final PsiParameter[] superParameters = |
| superParameterList.getParameters(); |
| for (int i = 0; i < parameters.length; i++) { |
| final PsiParameter parameter = parameters[i]; |
| final String parameterName = parameter.getName(); |
| final String superParameterName = superParameters[i].getName(); |
| if (superParameterName == null) { |
| continue; |
| } |
| if (superParameterName.equals(parameterName)) { |
| continue; |
| } |
| if (m_ignoreSingleCharacterNames && |
| superParameterName.length() == 1) { |
| continue; |
| } |
| registerVariableError(parameter, superParameterName); |
| } |
| } |
| } |
| } |