org.sonar.plugins.java.api.JavaFileScannerContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-squid Show documentation

There is a newer version: 3.2

/*
 * 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.plugins.java.api;

import com.google.common.annotations.Beta;
import org.sonar.api.rule.RuleKey;
import org.sonar.plugins.java.api.tree.ClassTree;
import org.sonar.plugins.java.api.tree.CompilationUnitTree;
import org.sonar.plugins.java.api.tree.MethodTree;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.squidbridge.api.CheckMessage;

import javax.annotation.Nullable;
import java.io.File;
import java.util.Set;

@Beta
public interface JavaFileScannerContext {

  CompilationUnitTree getTree();

  void addIssue(Tree tree, RuleKey ruleKey, String message);

  void addIssueOnFile(RuleKey ruleKey, String message);

  void addIssue(int line, RuleKey ruleKey, String message);

  void addIssue(Tree tree, CheckMessage checkMessage);

  @Nullable
  Object getSemanticModel();

  String getFileKey();

  File getFile();

  int getComplexity(Tree tree);

  int getMethodComplexity(ClassTree enclosingClass, MethodTree methodTree);

  void addNoSonarLines(Set lines);

}