org.sonar.api.batch.fs

Interface FileSystem

All Known Implementing Classes:

DefaultFileSystem

@ScannerSide
public interface FileSystem

The FileSystem manages all the source files to be analyzed.

This is not an extension point so it must not be implemented by plugins. It must be injected as a constructor parameter :

 public class MySensor implements Sensor {
   private final FileSystem fs;

   public MySensor(FileSystem fs) {
     this.fs = fs;
   }
 }
 

How to use in unit tests

The unit tests needing an instance of FileSystem can use the implementation DefaultFileSystem and the related DefaultInputFile, for example :

 DefaultFileSystem fs = new DefaultFileSystem();
 fs.add(new DefaultInputFile("myprojectKey", "src/foo/bar.php"));
 

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileSystem.Index Interface of the underlying file index.

Method Summary

Modifier and Type	Method and Description
File	baseDir() Absolute base directory of module
Charset	encoding() Default encoding of files in this project.
Iterable<File>	files(FilePredicate predicate) Files matching the given predicate.
boolean	hasFiles(FilePredicate predicate) Returns true if at least one InputFile matches the given predicate.
InputDir	inputDir(File dir) Returns InputDir matching the current File.
InputFile	inputFile(FilePredicate predicate) Returns the single element matching the predicate.
Iterable<InputFile>	inputFiles(FilePredicate predicate) Input files matching the given attributes.
SortedSet<String>	languages() Languages detected in all files, whatever their type (main or test)
FilePredicates	predicates() Factory of FilePredicate
File	resolvePath(String path) Utility method mainly used to resolve location of reports.
File	workDir() Absolute work directory.

Method Detail

baseDir

File baseDir()

Absolute base directory of module

encoding

Charset encoding()

Default encoding of files in this project. If it's not defined, then the platform default encoding is returned. When reading an InputFile it is preferable to use InputFile.charset()

workDir

File workDir()

Absolute work directory. It can be used to store third-party analysis reports.
The work directory can be located outside baseDir().

predicates

FilePredicates predicates()

Factory of FilePredicate

inputFile

@CheckForNull
InputFile inputFile(FilePredicate predicate)

Returns the single element matching the predicate. If more than one elements match the predicate, then IllegalArgumentException is thrown. Returns null if no files match.

How to use :

 InputFile file = fs.inputFile(fs.predicates().hasRelativePath("src/Foo.php"));
 

See Also:

predicates()

inputDir

@CheckForNull
InputDir inputDir(File dir)

Returns InputDir matching the current File.

Returns:

null if directory is not indexed.

Throws:

IllegalArgumentException - is File is null or not a directory.

Since:

4.5

inputFiles

Iterable<InputFile> inputFiles(FilePredicate predicate)

Input files matching the given attributes. Return all the files if the parameter attributes is empty.

Important - result is an Iterable to benefit from streaming and decreasing memory consumption. It should be iterated only once, else copy it into a list : com.google.common.collect.Lists.newArrayList(inputFiles(predicate))

How to use :

 
 FilePredicates p = fs.predicates();
 Iterable<InputFile> files = fs.inputFiles(p.and(p.hasLanguage("java"), p.hasType(InputFile.Type.MAIN)));
 
 

See Also:

predicates()

hasFiles

boolean hasFiles(FilePredicate predicate)

Returns true if at least one InputFile matches the given predicate. This method can be faster than checking if inputFiles(org.sonar.api.batch.fs.FilePredicate) has elements.

See Also:

predicates()

files

Iterable<File> files(FilePredicate predicate)

Files matching the given predicate.

See Also:

predicates()

languages

SortedSet<String> languages()

Languages detected in all files, whatever their type (main or test)

resolvePath

File resolvePath(String path)

Utility method mainly used to resolve location of reports.

Returns:

file in canonical form from specified path. Path can be absolute or relative to project basedir. For example resolvePath("pom.xml") or resolvePath("src/main/java")

Since:

5.0