org.sonar.java.checks.SunPackagesUsedCheck 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.squid.checks.SquidCheck;
import org.sonar.check.BelongsToProfile;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.java.ast.parser.JavaGrammar;
import org.sonar.sslr.parser.LexerlessGrammar;

@Rule(
  key = "S1191",
  priority = Priority.MAJOR)
@BelongsToProfile(title = "Sonar way", priority = Priority.MAJOR)
public class SunPackagesUsedCheck extends SquidCheck {

  private int lastReportedLine;

  @Override
  public void init() {
    subscribeTo(JavaGrammar.QUALIFIED_IDENTIFIER);
    subscribeTo(JavaGrammar.CLASS_TYPE);
    subscribeTo(JavaGrammar.CREATED_NAME);
  }

  @Override
  public void visitFile(AstNode node) {
    lastReportedLine = -1;
  }

  @Override
  public void visitNode(AstNode node) {
    if (lastReportedLine != node.getTokenLine() && isSunClass(node)) {
      getContext().createLineViolation(this, "Replace this usage of Sun classes by ones from the Java API.", node);
      lastReportedLine = node.getTokenLine();
    }
  }

  private static boolean isSunClass(AstNode node) {
    String reference = merge(node);
    return reference.startsWith("com.sun.") || reference.startsWith("sun.");
  }

  private static String merge(AstNode node) {
    StringBuilder sb = new StringBuilder();

    for (Token token : node.getTokens()) {
      sb.append(token.getOriginalValue());
    }

    return sb.toString();
  }

}