org.sonar.java.checks.ProtectedMemberInFinalClassCheck.java Source code

Introduction

Here is the source code for org.sonar.java.checks.ProtectedMemberInFinalClassCheck.java

Source

/*
 * SonarQube Java
 * Copyright (C) 2012-2017 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.java.checks;

import com.google.common.collect.ImmutableList;

import org.apache.commons.lang.BooleanUtils;
import org.sonar.check.Rule;
import org.sonar.java.model.ModifiersUtils;
import org.sonar.java.model.declaration.MethodTreeImpl;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.semantic.Symbol;
import org.sonar.plugins.java.api.tree.ClassTree;
import org.sonar.plugins.java.api.tree.MethodTree;
import org.sonar.plugins.java.api.tree.Modifier;
import org.sonar.plugins.java.api.tree.ModifierKeywordTree;
import org.sonar.plugins.java.api.tree.ModifiersTree;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.Tree.Kind;
import org.sonar.plugins.java.api.tree.VariableTree;

import java.util.List;

@Rule(key = "S2156")
public class ProtectedMemberInFinalClassCheck extends IssuableSubscriptionVisitor {

    private static final String GUAVA_FQCN = "com.google.common.annotations.VisibleForTesting";
    private static final String MESSAGE = "Remove this \"protected\" modifier.";

    @Override
    public List<Kind> nodesToVisit() {
        return ImmutableList.of(Tree.Kind.CLASS);
    }

    @Override
    public void visitNode(Tree tree) {
        if (!hasSemantic()) {
            return;
        }
        ClassTree classTree = (ClassTree) tree;
        if (ModifiersUtils.hasModifier(classTree.modifiers(), Modifier.FINAL)) {
            classTree.members().forEach(this::checkMember);
        }
    }

    private void checkMember(Tree member) {
        if (member.is(Kind.VARIABLE)) {
            VariableTree variableTree = (VariableTree) member;
            checkVariableCompliance(variableTree);
        } else if (member.is(Kind.METHOD)) {
            MethodTreeImpl methodTree = (MethodTreeImpl) member;
            if (BooleanUtils.isFalse(methodTree.isOverriding())) {
                checkMethodCompliance(methodTree);
            }
        }
    }

    private void checkMethodCompliance(MethodTree methodTree) {
        checkComplianceOnModifiersAndSymbol(methodTree.modifiers(), methodTree.symbol());
    }

    private void checkVariableCompliance(VariableTree variableTree) {
        checkComplianceOnModifiersAndSymbol(variableTree.modifiers(), variableTree.symbol());
    }

    private void checkComplianceOnModifiersAndSymbol(ModifiersTree modifiers, Symbol symbol) {
        ModifierKeywordTree modifier = ModifiersUtils.getModifier(modifiers, Modifier.PROTECTED);
        if (modifier != null && !isVisibleForTesting(symbol)) {
            reportIssue(modifier.keyword(), MESSAGE);
        }
    }

    private static boolean isVisibleForTesting(Symbol symbol) {
        return symbol.metadata().isAnnotatedWith(GUAVA_FQCN);
    }

}