org.sonar.api.resources
Interface ProjectFileSystem

All Known Implementing Classes:

DefaultProjectFileSystem

public interface ProjectFileSystem

Method Summary

ProjectFileSystem	addSourceDir(java.io.File dir)
ProjectFileSystem	addTestDir(java.io.File dir)
java.io.File	getBasedir() Basedir is the project root directory.
java.io.File	getBuildDir() Build directory is by default "target" in maven projects.
java.io.File	getBuildOutputDir()
java.io.File	getFileFromBuildDirectory(java.lang.String filename)
java.util.List<java.io.File>	getJavaSourceFiles()
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)
java.util.List<java.io.File>	getTestDirs()
java.util.List<java.io.File>	getTestFiles(Language... langs)
boolean	hasJavaSourceFiles()
boolean	hasTestFiles(Language lang)
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. Never null, it returns the default plateform charset if it is not defined in project.

getBasedir

java.io.File getBasedir()

Basedir is the project root directory.

getBuildDir

java.io.File getBuildDir()

Build directory is by default "target" 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)

Parameters:

langs - filter on languages. No filter if null.

getJavaSourceFiles

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

hasJavaSourceFiles

boolean hasJavaSourceFiles()

getTestFiles

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

hasTestFiles

boolean hasTestFiles(Language lang)

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)