org.sonar.batch
Class DefaultProjectFileSystem2

java.lang.Object
  extended by org.sonar.api.resources.DefaultProjectFileSystem
      extended by org.sonar.batch.DefaultProjectFileSystem2
All Implemented Interfaces:
BatchComponent, ProjectFileSystem

public class DefaultProjectFileSystem2
extends DefaultProjectFileSystem

Implementation of ProjectFileSystem based on ProjectDefinition and MavenProject.


Field Summary
 
Fields inherited from class org.sonar.api.resources.DefaultProjectFileSystem
DIRECTORY_EXISTS
 
Constructor Summary
DefaultProjectFileSystem2(Project project, Languages languages, ProjectDefinition def)
           
DefaultProjectFileSystem2(Project project, Languages languages, ProjectDefinition def, FileFilter[] fileFilters)
           
DefaultProjectFileSystem2(Project project, Languages languages, ProjectDefinition def, org.apache.maven.project.MavenProject pom)
          For Maven.
DefaultProjectFileSystem2(Project project, Languages languages, ProjectDefinition def, org.apache.maven.project.MavenProject pom, FileFilter[] fileFilters)
          For Maven.
 
Method Summary
 DefaultProjectFileSystem addSourceDir(File dir)
          Deprecated. since 2.6, because should be immutable
 DefaultProjectFileSystem addTestDir(File dir)
          Deprecated. since 2.6, because should be immutable
 File getBasedir()
          Project root directory.
 File getBuildDir()
          Build directory.
 File getBuildOutputDir()
          Directory where classes are placed.
protected  List<File> getInitialSourceFiles()
           
protected  List<File> getInitialTestFiles()
           
 File getReportOutputDir()
          TODO Godin: seems that used only by Cobertura and Clover
 File getSonarWorkingDirectory()
           
 List<File> getSourceDirs()
          Maven can modify source directories during Sonar execution - see MavenPhaseExecutor.
 List<File> getTestDirs()
          Maven can modify test directories during Sonar execution - see MavenPhaseExecutor.
 
Methods inherited from class org.sonar.api.resources.DefaultProjectFileSystem
getFileFromBuildDirectory, getJavaSourceFiles, getRelativePath, getRelativePath, getSourceCharset, getSourceFiles, getTestFiles, hasJavaSourceFiles, hasTestFiles, mainFiles, resolvePath, resolvePaths, testFiles, toResource, writeToFile, writeToWorkingDirectory
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultProjectFileSystem2

public DefaultProjectFileSystem2(Project project,
                                 Languages languages,
                                 ProjectDefinition def,
                                 FileFilter[] fileFilters)

DefaultProjectFileSystem2

public DefaultProjectFileSystem2(Project project,
                                 Languages languages,
                                 ProjectDefinition def,
                                 org.apache.maven.project.MavenProject pom,
                                 FileFilter[] fileFilters)
For Maven.


DefaultProjectFileSystem2

public DefaultProjectFileSystem2(Project project,
                                 Languages languages,
                                 ProjectDefinition def)

DefaultProjectFileSystem2

public DefaultProjectFileSystem2(Project project,
                                 Languages languages,
                                 ProjectDefinition def,
                                 org.apache.maven.project.MavenProject pom)
For Maven.

Method Detail

getBasedir

public File getBasedir()
Description copied from interface: ProjectFileSystem
Project root directory.

Specified by:
getBasedir in interface ProjectFileSystem
Overrides:
getBasedir in class DefaultProjectFileSystem

getBuildDir

public File getBuildDir()
Description copied from interface: ProjectFileSystem
Build directory. It's "${basedir}/target" by default in Maven projects.

Specified by:
getBuildDir in interface ProjectFileSystem
Overrides:
getBuildDir in class DefaultProjectFileSystem

getBuildOutputDir

public File getBuildOutputDir()
Description copied from interface: ProjectFileSystem
Directory where classes are placed. It's "${basedir}/target/classes" by default in Maven projects.

Specified by:
getBuildOutputDir in interface ProjectFileSystem
Overrides:
getBuildOutputDir in class DefaultProjectFileSystem

getSourceDirs

public List<File> getSourceDirs()
Description copied from class: DefaultProjectFileSystem
Maven can modify source directories during Sonar execution - see MavenPhaseExecutor.

Specified by:
getSourceDirs in interface ProjectFileSystem
Overrides:
getSourceDirs in class DefaultProjectFileSystem

addSourceDir

@Deprecated
public DefaultProjectFileSystem addSourceDir(File dir)
Deprecated. since 2.6, because should be immutable

Description copied from interface: ProjectFileSystem
Adds a source directory

Specified by:
addSourceDir in interface ProjectFileSystem
Overrides:
addSourceDir in class DefaultProjectFileSystem
Returns:
the current object

getTestDirs

public List<File> getTestDirs()
Maven can modify test directories during Sonar execution - see MavenPhaseExecutor.

Specified by:
getTestDirs in interface ProjectFileSystem
Overrides:
getTestDirs in class DefaultProjectFileSystem

addTestDir

@Deprecated
public DefaultProjectFileSystem addTestDir(File dir)
Deprecated. since 2.6, because should be immutable

Description copied from interface: ProjectFileSystem
Adds a test directory

Specified by:
addTestDir in interface ProjectFileSystem
Overrides:
addTestDir in class DefaultProjectFileSystem
Returns:
the current object

getReportOutputDir

public File getReportOutputDir()
TODO Godin: seems that used only by Cobertura and Clover

Specified by:
getReportOutputDir in interface ProjectFileSystem
Overrides:
getReportOutputDir in class DefaultProjectFileSystem
Returns:
the directory where reporting is placed. Default is target/sites

getSonarWorkingDirectory

public File getSonarWorkingDirectory()
Specified by:
getSonarWorkingDirectory in interface ProjectFileSystem
Overrides:
getSonarWorkingDirectory in class DefaultProjectFileSystem
Returns:
the Sonar working directory. Default is "target/sonar"

getInitialSourceFiles

protected List<File> getInitialSourceFiles()
Overrides:
getInitialSourceFiles in class DefaultProjectFileSystem

getInitialTestFiles

protected List<File> getInitialTestFiles()
Overrides:
getInitialTestFiles in class DefaultProjectFileSystem


Copyright © 2009-2012 SonarSource. All Rights Reserved.