org.sonar.java

Class DefaultJavaResourceLocator

java.lang.Object

org.sonar.java.DefaultJavaResourceLocator

All Implemented Interfaces:

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

public class DefaultJavaResourceLocator
extends Object
implements JavaResourceLocator

Constructor Summary

Constructors

Constructor and Description
DefaultJavaResourceLocator(org.sonar.api.batch.fs.FileSystem fs, JavaClasspath javaClasspath)

Method Summary

Modifier and Type	Method and Description
Collection<File>	classFilesToAnalyze() .class files to be analyzed.
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) get source file key by class name.
void	scanFile(JavaFileScannerContext context) Method called after parsing and semantic analysis has been done on file.
void	setSensorContext(org.sonar.api.batch.sensor.SensorContext sensorContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultJavaResourceLocator

public DefaultJavaResourceLocator(org.sonar.api.batch.fs.FileSystem fs,
                                  JavaClasspath javaClasspath)

Method Detail

setSensorContext

public void setSensorContext(org.sonar.api.batch.sensor.SensorContext sensorContext)

findResourceByClassName

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

Description copied from interface: JavaResourceLocator

Retrieve a SonarQube resource by the class name.

Specified by:

findResourceByClassName in interface JavaResourceLocator

Parameters:

className - fully qualified name of the analyzed class

Returns:

null if not found

findSourceFileKeyByClassName

public String findSourceFileKeyByClassName(String className)

Description copied from interface: JavaResourceLocator

get source file key by class name.

Specified by:

findSourceFileKeyByClassName in interface JavaResourceLocator

Parameters:

className - fully qualified name of the analyzed class.

Returns:

key of the source file for the given class.

classFilesToAnalyze

public Collection<File> classFilesToAnalyze()

Description copied from interface: JavaResourceLocator

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

Specified by:

classFilesToAnalyze in interface JavaResourceLocator

Returns:

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

classpath

public Collection<File> classpath()

Description copied from interface: JavaResourceLocator

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

Specified by:

classpath in interface JavaResourceLocator

Returns:

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

scanFile

public void scanFile(JavaFileScannerContext context)

Description copied from interface: JavaFileScanner

Method called after parsing and semantic analysis has been done on file.

Specified by:

scanFile in interface JavaFileScanner

Parameters:

context - Context of analysis containing the parsed tree.