org.sonar.api.resources
Interface ProjectFileSystem

All Known Implementing Classes:

DefaultProjectFileSystem

public interface ProjectFileSystem

Since:

1.10

Method Summary

ProjectFileSystem	addSourceDir(java.io.File dir)
ProjectFileSystem	addTestDir(java.io.File dir)
java.io.File	getBasedir() Project root directory.
java.io.File	getBuildDir() Build directory.
java.io.File	getBuildOutputDir()
java.io.File	getFileFromBuildDirectory(java.lang.String filename)
java.util.List<java.io.File>	getJavaSourceFiles() Java source files, excluding unit tests and files matching project exclusion patterns.
java.io.File	getReportOutputDir()
java.io.File	getSonarWorkingDirectory()
java.nio.charset.Charset	getSourceCharset() Source encoding.
java.util.List<java.io.File>	getSourceDirs()
java.util.List<java.io.File>	getSourceFiles(Language... langs) Source files, excluding unit tests and files matching project exclusion patterns.
java.util.List<java.io.File>	getTestDirs()
java.util.List<java.io.File>	getTestFiles(Language... langs) Unit test files, excluding files matching project exclusion patterns.
boolean	hasJavaSourceFiles() Check if the project has Java files, excluding unit tests and files matching project exclusion patterns.
boolean	hasTestFiles(Language lang) Check if the project has unit test files, excluding files matching project exclusion patterns.
java.io.File	resolvePath(java.lang.String path) Get file from path.
Resource	toResource(java.io.File file)
java.io.File	writeToWorkingDirectory(java.lang.String content, java.lang.String fileName) Save data into a new file of Sonar working directory.

Method Detail

getSourceCharset

java.nio.charset.Charset getSourceCharset()

Source encoding. It's the default plateform charset if it is not defined in the project (Maven property 'project.build.sourceEncoding').

getBasedir

java.io.File getBasedir()

Project root directory.

getBuildDir

java.io.File getBuildDir()

Build directory. It's "${basedir}/target" by default in Maven projects.

getBuildOutputDir

java.io.File getBuildOutputDir()

getSourceDirs

java.util.List<java.io.File> getSourceDirs()

addSourceDir

ProjectFileSystem addSourceDir(java.io.File dir)

getTestDirs

java.util.List<java.io.File> getTestDirs()

addTestDir

ProjectFileSystem addTestDir(java.io.File dir)

getReportOutputDir

java.io.File getReportOutputDir()

getSonarWorkingDirectory

java.io.File getSonarWorkingDirectory()

resolvePath

java.io.File resolvePath(java.lang.String path)

Get file from path. It can be absolute or relative to project basedir. For example resolvePath("pom.xml") or resolvePath("src/main/java")

getSourceFiles

java.util.List<java.io.File> getSourceFiles(Language... langs)

Source files, excluding unit tests and files matching project exclusion patterns.

Parameters:

langs - language filter. Check all files, whatever their language, if null or empty.

getJavaSourceFiles

java.util.List<java.io.File> getJavaSourceFiles()

Java source files, excluding unit tests and files matching project exclusion patterns. Shortcut for getSourceFiles(Java.INSTANCE)

hasJavaSourceFiles

boolean hasJavaSourceFiles()

Check if the project has Java files, excluding unit tests and files matching project exclusion patterns.

getTestFiles

java.util.List<java.io.File> getTestFiles(Language... langs)

Unit test files, excluding files matching project exclusion patterns.

hasTestFiles

boolean hasTestFiles(Language lang)

Check if the project has unit test files, excluding files matching project exclusion patterns.

writeToWorkingDirectory

java.io.File writeToWorkingDirectory(java.lang.String content,
                                     java.lang.String fileName)
                                     throws java.io.IOException

Save data into a new file of Sonar working directory.

Returns:

the created file

Throws:

java.io.IOException

getFileFromBuildDirectory

java.io.File getFileFromBuildDirectory(java.lang.String filename)

toResource

Resource toResource(java.io.File file)