org.sonar.java.checks.AbstractDeprecatedChecker Maven / Gradle / Ivy

Go to download
/*
 * SonarQube Java
 * Copyright (C) 2012 SonarSource
 * [email protected]
 *
 * 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  02
 */
package org.sonar.java.checks;

import com.sonar.sslr.api.AstNode;
import com.sonar.sslr.api.Token;
import com.sonar.sslr.api.Trivia;
import com.sonar.sslr.squid.checks.SquidCheck;
import org.sonar.java.ast.api.JavaTokenType;
import org.sonar.java.ast.parser.JavaGrammar;
import org.sonar.sslr.ast.AstSelect;
import org.sonar.sslr.parser.LexerlessGrammar;

public class AbstractDeprecatedChecker extends SquidCheck {

  @Override
  public void init() {
    subscribeTo(
        JavaGrammar.TYPE_DECLARATION,
        JavaGrammar.CLASS_BODY_DECLARATION,
        JavaGrammar.INTERFACE_BODY_DECLARATION,
        JavaGrammar.ANNOTATION_TYPE_ELEMENT_DECLARATION,
        JavaGrammar.BLOCK_STATEMENT);
  }

  public static boolean isDeprecated(AstNode node) {
    AstNode qualifiedIdentifier = node.getFirstChild(JavaGrammar.QUALIFIED_IDENTIFIER);
    return qualifiedIdentifier.getNumberOfChildren() == 1 &&
      "Deprecated".equals(qualifiedIdentifier.getFirstChild(JavaTokenType.IDENTIFIER).getTokenOriginalValue());
  }

  public static boolean hasJavadocDeprecatedTag(AstNode node) {
    Token token = node.getToken();
    for (Trivia trivia : token.getTrivia()) {
      String comment = trivia.getToken().getOriginalValue();
      if (hasJavadocDeprecatedTag(comment)) {
        return true;
      }
    }
    return false;
  }

  public static boolean hasJavadocDeprecatedTag(String comment) {
    return comment.startsWith("/**") && comment.contains("@deprecated");
  }

  public static boolean hasDeprecatedAnnotationExcludingLocalVariables(AstNode node) {
    AstSelect annotations = node.select()
        .children(JavaGrammar.MODIFIER)
        .children(JavaGrammar.ANNOTATION);

    return hasDeprecatedAnnotation(annotations);
  }

  public static boolean hasDeprecatedAnnotationOnLocalVariables(AstNode node) {
    AstSelect annotations = node.select()
        .children(JavaGrammar.LOCAL_VARIABLE_DECLARATION_STATEMENT)
        .children(JavaGrammar.VARIABLE_MODIFIERS)
        .children(JavaGrammar.ANNOTATION);

    return hasDeprecatedAnnotation(annotations);
  }

  public static boolean hasDeprecatedAnnotation(Iterable query) {
    for (AstNode annotation : query) {
      if (isDeprecated(annotation)) {
        return true;
      }
    }

    return false;
  }

}