org.sonar.api.resources
Class Project

java.lang.Object
  org.sonar.api.resources.Resource
      org.sonar.api.resources.Project

public class Project
extends Resource

A class that manipulates Projects in the Sonar way, i.e. mixing MavenProjects with the way it should be analyzed

Since:

1.10

Nested Class Summary

static class

Project.AnalysisType Enumerates the type of possible analysis

Field Summary

static java.lang.String	PARAM_DATE Deprecated. since version 1.11. Constant moved to CoreProperties
static java.lang.String	PARAM_DYNAMIC_ANALYSIS Deprecated. since version 1.11. Constant moved to CoreProperties
static java.lang.String	PARAM_EXCLUSIONS Deprecated. since version 1.11. Constant moved to CoreProperties
static java.lang.String	PARAM_LANGUAGE Deprecated. since version 1.11. Constant moved to CoreProperties
static java.lang.String	PARAM_REUSE_RULES_CONFIG Deprecated. since version 1.11. Constant moved to CoreProperties
static java.lang.String	PARAM_VERSION Deprecated. since version 1.11. Constant moved to CoreProperties

Fields inherited from class org.sonar.api.resources.Resource

QUALIFIER_CLASS, QUALIFIER_DIRECTORY, QUALIFIER_FIELD, QUALIFIER_FILE, QUALIFIER_LIB, QUALIFIER_METHOD, QUALIFIER_MODULE, QUALIFIER_PACKAGE, QUALIFIER_PROJECT, QUALIFIER_PROJECT_BRANCH, QUALIFIER_PROJECT_TRUNK, QUALIFIER_SUBVIEW, QUALIFIER_UNIT_TEST_CLASS, QUALIFIER_VIEW, SCOPE_DIRECTORY, SCOPE_ENTITY, SCOPE_FILE, SCOPE_PROJECT, SCOPE_SET, SCOPE_SPACE

Constructor Summary

Project(java.lang.String key)

Project(java.lang.String key, java.lang.String branch, java.lang.String name)

Method Summary

static Project	createFromMavenIds(java.lang.String groupId, java.lang.String artifactId)
java.util.Date	getAnalysisDate()
Project.AnalysisType	getAnalysisType()
java.lang.String	getAnalysisVersion()
java.lang.String	getArtifactId() Used for Maven projects
java.lang.String	getBranch()
org.apache.commons.configuration.Configuration	getConfiguration()
java.lang.String	getDescription()
java.lang.String[]	getExclusionPatterns() Patterns of resource exclusion as defined in project settings page.
ProjectFileSystem	getFileSystem()
java.lang.String	getGroupId() Used for Maven projects
Language	getLanguage()
java.lang.String	getLanguageKey()
java.lang.String	getLongName()
java.util.List<Project>	getModules()
java.lang.String	getName()
java.lang.String	getPackaging()
Project	getParent() The parent is used to build the resources tree, for example for relations between classes, packages and projects.
org.apache.maven.project.MavenProject	getPom()
java.lang.Object	getProperty(java.lang.String key)
java.lang.String	getQualifier()
boolean	getReuseExistingRulesConfig()
Project	getRoot()
java.lang.String	getScope()
boolean	isLatestAnalysis() whether it's the latest analysis done on this project (displayed in sonar dashboard) or an analysis on a past revision.
boolean	isModule()
boolean	isRoot()
boolean	matchFilePattern(java.lang.String antPattern) Check resource against an Ant pattern, like mypackag?/*Foo.java.
void	removeFromParent() For internal use only.
Project	setAnalysisDate(java.util.Date analysisDate) For internal use only.
Project	setAnalysisType(Project.AnalysisType at)
Project	setAnalysisVersion(java.lang.String analysisVersion) For internal use only.
Project	setBranch(java.lang.String branch)
Project	setConfiguration(org.apache.commons.configuration.Configuration configuration) Sets the configuration
Project	setDescription(java.lang.String description)
Project	setExclusionPatterns(java.lang.String[] s) Set exclusion patterns.
Project	setFileSystem(ProjectFileSystem fs)
Project	setLanguage(Language language)
Project	setLanguageKey(java.lang.String languageKey) For internal use only.
Project	setLatestAnalysis(boolean b) For internal use only.
Project	setName(java.lang.String name)
Project	setPackaging(java.lang.String packaging)
Project	setParent(Project parent) For internal use only.
Project	setPom(org.apache.maven.project.MavenProject pom)
java.lang.String	toString()

Methods inherited from class org.sonar.api.resources.Resource

equals, getEffectiveKey, getId, getKey, hashCode, isExcluded, setEffectiveKey, setExcluded, setId, setKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAM_VERSION

@Deprecated
public static final java.lang.String PARAM_VERSION

Deprecated. since version 1.11. Constant moved to CoreProperties

See Also:

Constant Field Values

PARAM_DATE

@Deprecated
public static final java.lang.String PARAM_DATE

Deprecated. since version 1.11. Constant moved to CoreProperties

See Also:

Constant Field Values

PARAM_LANGUAGE

@Deprecated
public static final java.lang.String PARAM_LANGUAGE

Deprecated. since version 1.11. Constant moved to CoreProperties

See Also:

Constant Field Values

PARAM_DYNAMIC_ANALYSIS

@Deprecated
public static final java.lang.String PARAM_DYNAMIC_ANALYSIS

Deprecated. since version 1.11. Constant moved to CoreProperties

See Also:

Constant Field Values

PARAM_EXCLUSIONS

@Deprecated
public static final java.lang.String PARAM_EXCLUSIONS

Deprecated. since version 1.11. Constant moved to CoreProperties

See Also:

Constant Field Values

PARAM_REUSE_RULES_CONFIG

@Deprecated
public static final java.lang.String PARAM_REUSE_RULES_CONFIG

Deprecated. since version 1.11. Constant moved to CoreProperties

See Also:

Constant Field Values

Constructor Detail

Project

public Project(java.lang.String key)

Project

public Project(java.lang.String key,
               java.lang.String branch,
               java.lang.String name)

Method Detail

getBranch

public java.lang.String getBranch()

setBranch

public Project setBranch(java.lang.String branch)

setPom

public final Project setPom(org.apache.maven.project.MavenProject pom)

getPackaging

public java.lang.String getPackaging()

Returns:

the project's packaging

getName

public java.lang.String getName()

Specified by:

getName in class Resource

Returns:

the resource name

getLongName

public java.lang.String getLongName()

Specified by:

getLongName in class Resource

Returns:

the resource long name

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in class Resource

Returns:

the resource description

setName

public Project setName(java.lang.String name)

setDescription

public Project setDescription(java.lang.String description)

setPackaging

public Project setPackaging(java.lang.String packaging)

isRoot

public boolean isRoot()

Returns:

whether the current project is root project

getRoot

public Project getRoot()

isModule

public boolean isModule()

Returns:

whether the current project is a module

getAnalysisType

public Project.AnalysisType getAnalysisType()

Returns:

the type of analysis of the project

setAnalysisType

public Project setAnalysisType(Project.AnalysisType at)

isLatestAnalysis

public boolean isLatestAnalysis()

whether it's the latest analysis done on this project (displayed in sonar dashboard) or an analysis on a past revision.

Since:

2.0

setLatestAnalysis

public Project setLatestAnalysis(boolean b)

For internal use only.

getGroupId

public java.lang.String getGroupId()

Used for Maven projects

getArtifactId

public java.lang.String getArtifactId()

Used for Maven projects

getLanguage

public Language getLanguage()

Specified by:

getLanguage in class Resource

Returns:

the project language

setLanguage

public Project setLanguage(Language language)

getLanguageKey

public java.lang.String getLanguageKey()

Returns:

the language key

setLanguageKey

public Project setLanguageKey(java.lang.String languageKey)

For internal use only.

setAnalysisDate

public Project setAnalysisDate(java.util.Date analysisDate)

For internal use only.

setAnalysisVersion

public Project setAnalysisVersion(java.lang.String analysisVersion)

For internal use only.

getScope

public java.lang.String getScope()

Specified by:

getScope in class Resource

Returns:

the scope of the current object

getQualifier

public java.lang.String getQualifier()

Specified by:

getQualifier in class Resource

Returns:

the qualifier of the current object

matchFilePattern

public boolean matchFilePattern(java.lang.String antPattern)

Description copied from class: Resource

Check resource against an Ant pattern, like mypackag?/*Foo.java. It's used for example to match resource exclusions.

Specified by:

matchFilePattern in class Resource

Parameters:

antPattern - Ant-like pattern (with **, * and ?). It includes file suffixes.

Returns:

true if the resource matches the Ant pattern

getParent

public Project getParent()

Description copied from class: Resource

The parent is used to build the resources tree, for example for relations between classes, packages and projects.

Return null if the parent is the project.

Specified by:

getParent in class Resource

setParent

public Project setParent(Project parent)

For internal use only.

removeFromParent

public void removeFromParent()

For internal use only.

getModules

public java.util.List<Project> getModules()

Returns:

the list of modules

getReuseExistingRulesConfig

public boolean getReuseExistingRulesConfig()

Returns:

whether to use external source for rules configuration

getAnalysisVersion

public java.lang.String getAnalysisVersion()

Returns:

the current version of the project

getAnalysisDate

public java.util.Date getAnalysisDate()

Returns:

the analysis date, i.e. the date that will be used to store the snapshot

getExclusionPatterns

public java.lang.String[] getExclusionPatterns()

Patterns of resource exclusion as defined in project settings page.

setExclusionPatterns

public Project setExclusionPatterns(java.lang.String[] s)

Set exclusion patterns. Configuration is not saved, so this method must be used ONLY IN UNIT TESTS.

getFileSystem

public ProjectFileSystem getFileSystem()

setFileSystem

public Project setFileSystem(ProjectFileSystem fs)

getPom

public org.apache.maven.project.MavenProject getPom()

Returns:

the underlying maven project

getConfiguration

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

Returns:

the project configuration

setConfiguration

public final Project setConfiguration(org.apache.commons.configuration.Configuration configuration)

Sets the configuration

Returns:

the current object

getProperty

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

createFromMavenIds

public static Project createFromMavenIds(java.lang.String groupId,
                                         java.lang.String artifactId)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object