org.sonar.api.scan.filesystem
Interface ModuleFileSystem

All Superinterfaces:

BatchComponent

Deprecated. in 4.2. Replaced by FileSystem

@Deprecated
public interface ModuleFileSystem
extends BatchComponent

Since:

3.5

Method Summary

File	baseDir() Deprecated. Base directory.
List<File>	binaryDirs() Deprecated. since 4.2 sonar.binaries will be converted to java specific property
File	buildDir() Deprecated. Optional directory used by the build tool to generate various kinds of data (test reports, temp files, ...).
List<File>	files(FileQuery query) Deprecated. Search for files.
Charset	sourceCharset() Deprecated. Default charset for files of the module.
List<File>	sourceDirs() Deprecated. since 4.2 use FileSystem.files(org.sonar.api.batch.fs.FilePredicate) to get all files with type InputFile.Type#MAIN.
List<File>	testDirs() Deprecated. since 4.2 use FileSystem.files(org.sonar.api.batch.fs.FilePredicate) to get all files with type InputFile.Type#TEST.
File	workingDir() Deprecated. Working directory used by Sonar.

Method Detail

baseDir

File baseDir()

Deprecated.

Base directory.

buildDir

@CheckForNull
File buildDir()

Deprecated.

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()

Deprecated. since 4.2 use FileSystem.files(org.sonar.api.batch.fs.FilePredicate) to get all files with type InputFile.Type#MAIN.

Source directories.

testDirs

List<File> testDirs()

Deprecated. since 4.2 use FileSystem.files(org.sonar.api.batch.fs.FilePredicate) to get all files with type InputFile.Type#TEST.

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

binaryDirs

List<File> binaryDirs()

Deprecated. since 4.2 sonar.binaries will be converted to java specific property

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)

Deprecated.

Search for files. Never return null.

sourceCharset

Charset sourceCharset()

Deprecated.

Default charset for files of the module. If it's not defined, then return the platform default charset. When trying to read an input file it is better to rely on InputFile#encoding() as encoding may be different for each file.

workingDir

File workingDir()

Deprecated.

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