org.sonar.api.scan.filesystem
Interface ModuleFileSystem

All Superinterfaces:

BatchComponent

public interface ModuleFileSystem
extends BatchComponent

Since:

3.5

Method Summary

File	baseDir() Base directory.
List<File>	binaryDirs() Optional directories that contain the compiled sources, for example java bytecode.
File	buildDir() Optional directory used by the build tool to generate various kinds of data (test reports, temp files, ...).
List<File>	files(FileQuery query) Search for files.
Charset	sourceCharset() Charset of source and test files.
List<File>	sourceDirs() Source directories.
List<File>	testDirs() Test directories.
File	workingDir() Working directory used by Sonar.

Method Detail

baseDir

File baseDir()

Base directory.

buildDir

@CheckForNull
File buildDir()

Optional directory used by the build tool to generate various kinds of data (test reports, temp files, ...). In Maven, it's given by the property ${project.build.directory}, which value is generally ${project.basedir}/target.

sourceDirs

List<File> sourceDirs()

Source directories. Non-existing directories are excluded. Example in Maven : ${project.basedir}/src/main/java

testDirs

List<File> testDirs()

Test directories. Non-existing directories are excluded. Example in Maven : ${project.basedir}/src/test/java

binaryDirs

List<File> binaryDirs()

Optional directories that contain the compiled sources, for example java bytecode. Note that :

• Maven projects have only a single binary directory, which is generally ${project.basedir}/target/classes
• Binary directories can be empty
• Test binary directories are not supported yet.

files

List<File> files(FileQuery query)

Search for files. Never return null.

sourceCharset

Charset sourceCharset()

Charset of source and test files. If it's not defined, then return the platform default charset.

workingDir

File workingDir()

Working directory used by Sonar. This directory can be used for example to store intermediary reports.