org.sonar.api.resources
Class DefaultProjectFileSystem

java.lang.Object
  org.sonar.api.resources.DefaultProjectFileSystem

All Implemented Interfaces:

ProjectFileSystem

public class DefaultProjectFileSystem
extends java.lang.Object
implements ProjectFileSystem

An implementation of ProjectFileSystem

Since:

1.10

Constructor Summary

DefaultProjectFileSystem(Project project)
Creates a DefaultProjectFileSystem based on a project

Method Summary

DefaultProjectFileSystem	addSourceDir(java.io.File dir) Adds a source directory
DefaultProjectFileSystem	addTestDir(java.io.File dir) Adds a test directory
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() Directory where classes are placed.
java.io.File	getFileFromBuildDirectory(java.lang.String filename)
java.util.List<java.io.File>	getJavaSourceFiles() Gets the list of java source files
static java.lang.String	getRelativePath(java.io.File file, java.io.File dir) getRelativePath("c:/foo/src/my/package/Hello.java", "c:/foo/src") is "my/package/Hello.java"
static java.lang.String	getRelativePath(java.io.File file, java.util.List<java.io.File> dirs) getRelativePath("c:/foo/src/my/package/Hello.java", ["c:/bar", "c:/foo/src"]) is "my/package/Hello.java".
java.io.File	getReportOutputDir()
java.io.File	getSonarWorkingDirectory()
java.nio.charset.Charset	getSourceCharset() Source encoding.
java.util.List<java.io.File>	getSourceDirs() The list of directories for sources
java.util.List<java.io.File>	getSourceFiles(Language... langs) Gets the list of source files for given languages
java.util.List<java.io.File>	getTestDirs() The list of directories for tests
java.util.List<java.io.File>	getTestFiles(Language... langs) Gets the list of test files for given languages
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)
protected static java.io.File	writeToFile(java.lang.String content, java.io.File dir, java.lang.String fileName)
java.io.File	writeToWorkingDirectory(java.lang.String content, java.lang.String fileName) Save data into a new file of Sonar working directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProjectFileSystem

public DefaultProjectFileSystem(Project project)

Creates a DefaultProjectFileSystem based on a project

Parameters:

project -

Method Detail

getSourceCharset

public java.nio.charset.Charset getSourceCharset()

Source encoding. Never null, it returns the default plateform charset if it is not defined in project.

Specified by:

getSourceCharset in interface ProjectFileSystem

getBasedir

public java.io.File getBasedir()

Basedir is the project root directory.

Specified by:

getBasedir in interface ProjectFileSystem

getBuildDir

public java.io.File getBuildDir()

Build directory is by default "target" in maven projects.

Specified by:

getBuildDir in interface ProjectFileSystem

getBuildOutputDir

public java.io.File getBuildOutputDir()

Directory where classes are placed. By default "target/classes" in maven projects.

Specified by:

getBuildOutputDir in interface ProjectFileSystem

getSourceDirs

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

The list of directories for sources

Specified by:

getSourceDirs in interface ProjectFileSystem

addSourceDir

public DefaultProjectFileSystem addSourceDir(java.io.File dir)

Adds a source directory

Specified by:

addSourceDir in interface ProjectFileSystem

Returns:

the current object

getTestDirs

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

The list of directories for tests

Specified by:

getTestDirs in interface ProjectFileSystem

addTestDir

public DefaultProjectFileSystem addTestDir(java.io.File dir)

Adds a test directory

Specified by:

addTestDir in interface ProjectFileSystem

Returns:

the current object

getReportOutputDir

public java.io.File getReportOutputDir()

Specified by:

getReportOutputDir in interface ProjectFileSystem

Returns:

the directory where reporting is placed. Default is target/sites

getSonarWorkingDirectory

public java.io.File getSonarWorkingDirectory()

Specified by:

getSonarWorkingDirectory in interface ProjectFileSystem

Returns:

the Sonar working directory. Default is "target/sonar"

resolvePath

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

Description copied from interface: ProjectFileSystem

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

Specified by:

resolvePath in interface ProjectFileSystem

getSourceFiles

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

Gets the list of source files for given languages

Specified by:

getSourceFiles in interface ProjectFileSystem

Parameters:

langs - language filter. If null or empty, will return empty list

getJavaSourceFiles

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

Gets the list of java source files

Specified by:

getJavaSourceFiles in interface ProjectFileSystem

hasJavaSourceFiles

public boolean hasJavaSourceFiles()

Description copied from interface: ProjectFileSystem

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

Specified by:

hasJavaSourceFiles in interface ProjectFileSystem

Returns:

whether there are java source

getTestFiles

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

Gets the list of test files for given languages

Specified by:

getTestFiles in interface ProjectFileSystem

Parameters:

langs - language filter. If null or empty, will return empty list

hasTestFiles

public boolean hasTestFiles(Language lang)

Description copied from interface: ProjectFileSystem

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

Specified by:

hasTestFiles in interface ProjectFileSystem

Returns:

whether there are tests files

writeToWorkingDirectory

public 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.

Specified by:

writeToWorkingDirectory in interface ProjectFileSystem

Returns:

the created file

Throws:

java.io.IOException

writeToFile

protected static java.io.File writeToFile(java.lang.String content,
                                          java.io.File dir,
                                          java.lang.String fileName)
                                   throws java.io.IOException

Throws:

java.io.IOException

getRelativePath

public static java.lang.String getRelativePath(java.io.File file,
                                               java.io.File dir)

getRelativePath("c:/foo/src/my/package/Hello.java", "c:/foo/src") is "my/package/Hello.java"

Returns:

null if file is not in dir (including recursive subdirectories)

getRelativePath

public static java.lang.String getRelativePath(java.io.File file,
                                               java.util.List<java.io.File> dirs)

getRelativePath("c:/foo/src/my/package/Hello.java", ["c:/bar", "c:/foo/src"]) is "my/package/Hello.java".

Relative path is composed of slashes. Windows backslaches are replaced by /

Returns:

null if file is not in dir (including recursive subdirectories)

getFileFromBuildDirectory

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

Specified by:

getFileFromBuildDirectory in interface ProjectFileSystem

toResource

public Resource toResource(java.io.File file)

Specified by:

toResource in interface ProjectFileSystem