org.sonar.plugins.java.api

Interface JavaResourceLocator

All Superinterfaces:

org.sonar.squidbridge.api.CodeVisitor, JavaCheck, JavaFileScanner

All Known Implementing Classes:

DefaultJavaResourceLocator

@Beta
 @BatchSide
public interface JavaResourceLocator
extends JavaFileScanner

Interface to get the mapping between java classes and files (as multiple classes can be declared in one file).

Method Summary

Modifier and Type	Method and Description
Collection<File>	classFilesToAnalyze() .class files to be analyzed.
Collection<String>	classKeys() Deprecated. since 4.1 : used by bytecode visitor scanner and should be dropped when it is removed.
Collection<File>	classpath() Classpath configured for the project.
org.sonar.api.batch.fs.InputFile	findResourceByClassName(String className) Retrieve a SonarQube resource by the class name.
String	findSourceFileKeyByClassName(String className) Deprecated. since 4.1 : will be dropped with no replacement.
Integer	getMethodStartLine(String fullyQualifiedMethodName) Deprecated. since 4.1 : used by bytecode visitor scanner and should be dropped when it is removed.

Methods inherited from interface org.sonar.plugins.java.api.JavaFileScanner

scanFile

Method Detail

findResourceByClassName

@CheckForNull
org.sonar.api.batch.fs.InputFile findResourceByClassName(String className)

Retrieve a SonarQube resource by the class name.

Parameters:

className - fully qualified name of the analyzed class

Returns:

null if not found

findSourceFileKeyByClassName

@Deprecated
String findSourceFileKeyByClassName(String className)

Deprecated. since 4.1 : will be dropped with no replacement.

get source file key by class name.

Parameters:

className - fully qualified name of the analyzed class.

Returns:

key of the source file for the given class.

classKeys

@Deprecated
Collection<String> classKeys()

Deprecated. since 4.1 : used by bytecode visitor scanner and should be dropped when it is removed.

fully qualified names of the classes to be analyzed by sonar java analyzer.

Returns:

collection of fully qualified names.

classFilesToAnalyze

Collection<File> classFilesToAnalyze()

.class files to be analyzed. Used by the findbugs plugin.

Returns:

a list of .class files corresponding to the source files to be analyzed.

classpath

Collection<File> classpath()

Classpath configured for the project. This classpath method is used by the findbugs plugin to configure the analysis.

Returns:

the list of jar and class files constituting the classpath of the analyzed project.

getMethodStartLine

@Deprecated
Integer getMethodStartLine(String fullyQualifiedMethodName)

Deprecated. since 4.1 : used by bytecode visitor scanner and should be dropped when it is removed.

Get the first line of a method definition.

Parameters:

fullyQualifiedMethodName - the full name of the method.

Returns:

the line number where this method is defined.