org.sonar.api.batch
Interface Project

All Superinterfaces:

Resource<Project>

public interface Project
extends Resource<Project>

See Also:

for utility methods.

Nested Class Summary

static class

Project.AnalysisType

Field Summary

Fields inherited from interface org.sonar.api.batch.Resource

QUALIFIER_CLASS, QUALIFIER_DIRECTORY, QUALIFIER_FILE, QUALIFIER_PACKAGE, QUALIFIER_PROJECT_BRANCH, QUALIFIER_PROJECT_TRUNK, QUALIFIER_UNIT_TEST_CLASS, SCOPE_DIRECTORY, SCOPE_FILE, SCOPE_FUNCTION, SCOPE_PROJECT

Method Summary

java.util.Date	getAnalysisDate()
Project.AnalysisType	getAnalysisType()
java.lang.String	getAnalysisVersion()
java.lang.String	getArtifactId()
java.io.File	getBasedir()
java.lang.String	getBranch()
java.io.File	getBuildDir()
java.io.File	getBuildOutputDir()
org.apache.commons.configuration.Configuration	getConfiguration() Configuration is loaded from sonar settings, system then maven pom.
java.lang.String[]	getExclusionPatterns() Never return null
java.lang.String	getGroupId()
org.apache.maven.project.MavenProject	getMavenProject()
java.lang.String	getPackaging()
java.lang.Object	getProperty(java.lang.String key)
java.io.File	getReportOutputDir()
Project	getRoot()
java.io.File	getSonarWorkingDirectory()
java.nio.charset.Charset	getSourceCharset()
java.util.List<java.io.File>	getSourceDirs()
java.util.List<java.io.File>	getSourceFiles(java.lang.String... languages) Source files with specified languages.
java.util.List<java.io.File>	getUnitTestDirs()
java.util.List<java.io.File>	getUnitTestFiles(java.lang.String... languages) Test files with specified languages.
boolean	isRoot()
java.io.File	resolvePath(java.lang.String path)

Methods inherited from interface org.sonar.api.batch.Resource

getDescription, getKey, getLanguage, getName, getParent, getQualifier, getScope, matchFilePattern

Method Detail

getRoot

Project getRoot()

isRoot

boolean isRoot()

getAnalysisType

Project.AnalysisType getAnalysisType()

getGroupId

java.lang.String getGroupId()

getArtifactId

java.lang.String getArtifactId()

getBranch

java.lang.String getBranch()

getPackaging

java.lang.String getPackaging()

getAnalysisVersion

java.lang.String getAnalysisVersion()

getAnalysisDate

java.util.Date getAnalysisDate()

getConfiguration

org.apache.commons.configuration.Configuration getConfiguration()

Configuration is loaded from sonar settings, system then maven pom.

getProperty

java.lang.Object getProperty(java.lang.String key)

getExclusionPatterns

java.lang.String[] getExclusionPatterns()

Never return null

getSourceCharset

java.nio.charset.Charset getSourceCharset()

getBasedir

java.io.File getBasedir()

getBuildDir

java.io.File getBuildDir()

getBuildOutputDir

java.io.File getBuildOutputDir()

getSourceDirs

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

getUnitTestDirs

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

getReportOutputDir

java.io.File getReportOutputDir()

resolvePath

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

getSonarWorkingDirectory

java.io.File getSonarWorkingDirectory()

getSourceFiles

java.util.List<java.io.File> getSourceFiles(java.lang.String... languages)

Source files with specified languages. Files matching exclusion settings are not included.

Parameters:

languages - language keys. If null or empty, then the filter is applied on all registered languages.

Returns:

never null

getUnitTestFiles

java.util.List<java.io.File> getUnitTestFiles(java.lang.String... languages)

Test files with specified languages. Files matching exclusion settings are not included.

Parameters:

languages - language keys. If null or empty, then the filter is applied on all registered languages.

Returns:

never null

getMavenProject

org.apache.maven.project.MavenProject getMavenProject()