All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonar.php.checks.RedundantFinalCheck Maven / Gradle / Ivy

/*
 * SonarQube PHP Plugin
 * Copyright (C) 2010-2024 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.php.checks;

import java.util.Collections;
import java.util.List;
import javax.annotation.Nullable;
import org.sonar.check.Rule;
import org.sonar.php.api.PHPKeyword;
import org.sonar.plugins.php.api.tree.Tree;
import org.sonar.plugins.php.api.tree.Tree.Kind;
import org.sonar.plugins.php.api.tree.declaration.ClassDeclarationTree;
import org.sonar.plugins.php.api.tree.declaration.ClassMemberTree;
import org.sonar.plugins.php.api.tree.declaration.MethodDeclarationTree;
import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
import org.sonar.plugins.php.api.visitors.PHPSubscriptionCheck;

@Rule(key = RedundantFinalCheck.KEY)
public class RedundantFinalCheck extends PHPSubscriptionCheck {

  public static final String KEY = "S1990";

  private static final String MESSAGE = "Remove this \"final\" modifier.";

  @Override
  public List nodesToVisit() {
    return Collections.singletonList(Kind.CLASS_DECLARATION);
  }

  @Override
  public void visitNode(Tree tree) {
    ClassDeclarationTree classDeclaration = (ClassDeclarationTree) tree;

    if (classDeclaration.isFinal()) {
      for (ClassMemberTree classMember : classDeclaration.members()) {
        checkClassMember(classMember);
      }
    }
  }

  private void checkClassMember(ClassMemberTree classMember) {
    if (classMember.is(Kind.METHOD_DECLARATION)) {
      SyntaxToken finalModifier = getFinalModifier((MethodDeclarationTree) classMember);
      if (finalModifier != null) {
        context().newIssue(this, finalModifier, MESSAGE);
      }
    }
  }

  @Nullable
  private static SyntaxToken getFinalModifier(MethodDeclarationTree methodDeclaration) {
    for (SyntaxToken modifier : methodDeclaration.modifiers()) {
      if (isFinalModifier(modifier)) {
        return modifier;
      }
    }
    return null;
  }

  private static boolean isFinalModifier(@Nullable SyntaxToken modifier) {
    return modifier != null && PHPKeyword.FINAL.getValue().equalsIgnoreCase(modifier.text());
  }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy