org.sonar.api.batch.fs.internal

Class DefaultFileSystem

java.lang.Object

org.sonar.api.batch.fs.internal.DefaultFileSystem

All Implemented Interfaces:

FileSystem

public class DefaultFileSystem
extends Object
implements FileSystem

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultFileSystem.Cache

Nested classes/interfaces inherited from interface org.sonar.api.batch.fs.FileSystem

FileSystem.Index

Field Summary

Fields

Modifier and Type	Field and Description
protected FilePredicates	predicates

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultFileSystem(File baseDir) Only for testing
protected	DefaultFileSystem(File baseDir, DefaultFileSystem.Cache cache)
	DefaultFileSystem(Path baseDir) Only for testing

Method Summary

Modifier and Type	Method and Description
DefaultFileSystem	add(DefaultInputDir inputDir) Adds InputDir to the list.
DefaultFileSystem	add(DefaultInputFile inputFile) Adds InputFile to the list and registers its language, if present.
DefaultFileSystem	addLanguages(String language, String... others) Adds a language to the list.
File	baseDir() Absolute base directory of module
Path	baseDirPath()
protected void	doPreloadFiles() This method is called before each search of files.
Charset	encoding() Default encoding of input files.
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() Bypass default predicate to get all files/dirs indexed.
Iterable<InputFile>	inputFiles(FilePredicate predicate) Input files matching the given attributes.
boolean	isDefaultJvmEncoding()
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.
DefaultFileSystem	setDefaultPredicate(FilePredicate predicate)
DefaultFileSystem	setEncoding(Charset e)
DefaultFileSystem	setWorkDir(File d)
File	workDir() Absolute work directory.

Methods inherited from class java.lang.Object

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

Field Detail

predicates

protected final FilePredicates predicates

Constructor Detail

DefaultFileSystem

public DefaultFileSystem(Path baseDir)

Only for testing

DefaultFileSystem

public DefaultFileSystem(File baseDir)

Only for testing

DefaultFileSystem

protected DefaultFileSystem(@Nullable
                            File baseDir,
                            DefaultFileSystem.Cache cache)

Method Detail

baseDirPath

public Path baseDirPath()

baseDir

public File baseDir()

Description copied from interface: FileSystem

Absolute base directory of module

Specified by:

baseDir in interface FileSystem

setEncoding

public DefaultFileSystem setEncoding(@Nullable
                                     Charset e)

encoding

public Charset encoding()

Description copied from interface: FileSystem

Default encoding of input files. If it's not defined, then the platform default encoding is returned

Specified by:

encoding in interface FileSystem

isDefaultJvmEncoding

public boolean isDefaultJvmEncoding()

setWorkDir

public DefaultFileSystem setWorkDir(File d)

setDefaultPredicate

public DefaultFileSystem setDefaultPredicate(@Nullable
                                             FilePredicate predicate)

workDir

public File workDir()

Description copied from interface: FileSystem

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

Specified by:

workDir in interface FileSystem

inputFile

public InputFile inputFile(FilePredicate predicate)

Description copied from interface: FileSystem

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"));
 

Specified by:

inputFile in interface FileSystem

See Also:

FileSystem.predicates()

inputFiles

public Iterable<InputFile> inputFiles()

Bypass default predicate to get all files/dirs indexed. Default predicate is used when some files/dirs should not be processed by sensors.

inputFiles

public Iterable<InputFile> inputFiles(FilePredicate predicate)

Description copied from interface: FileSystem

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

Specified by:

inputFiles in interface FileSystem

See Also:

FileSystem.predicates()

hasFiles

public boolean hasFiles(FilePredicate predicate)

Description copied from interface: FileSystem

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

Specified by:

hasFiles in interface FileSystem

See Also:

FileSystem.predicates()

files

public Iterable<File> files(FilePredicate predicate)

Description copied from interface: FileSystem

Files matching the given predicate.

Specified by:

files in interface FileSystem

See Also:

FileSystem.predicates()

inputDir

public InputDir inputDir(File dir)

Description copied from interface: FileSystem

Returns InputDir matching the current File.

Specified by:

inputDir in interface FileSystem

Returns:

null if directory is not indexed.

add

public DefaultFileSystem add(DefaultInputFile inputFile)

Adds InputFile to the list and registers its language, if present. Synchronized because PersistIt Exchange is not concurrent

add

public DefaultFileSystem add(DefaultInputDir inputDir)

Adds InputDir to the list. Synchronized because PersistIt Exchange is not concurrent

addLanguages

public DefaultFileSystem addLanguages(String language,
                                      String... others)

Adds a language to the list. To be used only for unit tests that need to use languages() without using add(DefaultInputFile).

languages

public SortedSet<String> languages()

Description copied from interface: FileSystem

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

Specified by:

languages in interface FileSystem

predicates

public FilePredicates predicates()

Description copied from interface: FileSystem

Factory of FilePredicate

Specified by:

predicates in interface FileSystem

doPreloadFiles

protected void doPreloadFiles()

This method is called before each search of files.

resolvePath

public File resolvePath(String path)

Description copied from interface: FileSystem

Utility method mainly used to resolve location of reports.

Specified by:

resolvePath in interface FileSystem

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