org.sonar.api.resources

Class Project

java.lang.Object

org.sonar.api.resources.Resource

org.sonar.api.resources.Project

All Implemented Interfaces:

Serializable, Component

Deprecated.

since 5.6 replaced by InputModule.

@Deprecated
public class Project
extends Resource
implements Component

Since:

1.10

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Language	NONE_LANGUAGE Deprecated. Internal use
static String	SCOPE Deprecated.

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

QUALIFIER_DIRECTORY, QUALIFIER_FILE, QUALIFIER_LIB, QUALIFIER_MODULE, QUALIFIER_PROJECT, QUALIFIER_SUBVIEW, QUALIFIER_VIEW, SCOPE_ENTITY, SCOPE_SET, SCOPE_SPACE

Constructor Summary

Constructors

Constructor and Description
Project(String key) Deprecated.
Project(String key, String branch, String name) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Project	createFromMavenIds(String groupId, String artifactId) Deprecated.
static Project	createFromMavenIds(String groupId, String artifactId, String branch) Deprecated.
Date	getAnalysisDate() Deprecated.
String	getAnalysisVersion() Deprecated.
String	getBranch() Deprecated.
String	getDescription() Deprecated.
Language	getLanguage() Deprecated.
String	getLanguageKey() Deprecated. since 4.2 use FileSystem.languages()
String	getLongName() Deprecated.
List<Project>	getModules() Deprecated.
String	getName() Deprecated.
Project	getParent() Deprecated. The parent is used to build the resources tree, for example for relations between files, directories and projects.
String	getQualifier() Deprecated. The qualifier tells the type of the resource.
Project	getRoot() Deprecated.
String	getScope() Deprecated.
Settings	getSettings() Deprecated. since 5.0
boolean	isModule() Deprecated.
boolean	isRoot() Deprecated.
String	key() Deprecated.
String	longName() Deprecated.
boolean	matchFilePattern(String antPattern) Deprecated. Check resource against an Ant pattern, like mypackag?/*Foo.java.
String	name() Deprecated.
String	path() Deprecated. Path of the component relative to basedir of the parent module.
String	qualifier() Deprecated.
void	removeFromParent() Deprecated. For internal use only.
Project	setAnalysisDate(Date analysisDate) Deprecated. For internal use only.
Project	setAnalysisVersion(String analysisVersion) Deprecated. For internal use only.
void	setBaseDir(File baseDir) Deprecated.
Project	setBranch(String branch) Deprecated. For internal use only.
Project	setDescription(String description) Deprecated. For internal use only.
Project	setLatestAnalysis(boolean b) Deprecated. in 3.6. It's not possible to analyze a project before the latest known quality snapshot. See http://jira.sonarsource.com/browse/SONAR-4334
Project	setName(String name) Deprecated. For internal use only.
Project	setParent(Project parent) Deprecated. For internal use only.
Project	setSettings(Settings settings) Deprecated. Internal use
String	toString() Deprecated.

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

equals, getEffectiveKey, getId, getKey, getPath, getUuid, hashCode, isExcluded, language, normalize, setEffectiveKey, setExcluded, setId, setKey, setPath, setUuid

Methods inherited from class java.lang.Object

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

Field Detail

NONE_LANGUAGE

public static final Language NONE_LANGUAGE

Deprecated.

Internal use

SCOPE

public static final String SCOPE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

Project

public Project(String key)

Deprecated.

Project

public Project(String key,
               String branch,
               String name)

Deprecated.

Method Detail

getBranch

public String getBranch()

Deprecated.

setBranch

public Project setBranch(String branch)

Deprecated.

For internal use only.

getName

public String getName()

Deprecated.

Specified by:

getName in class Resource

Returns:

the resource name

getLongName

public String getLongName()

Deprecated.

Specified by:

getLongName in class Resource

Returns:

the resource long name

getDescription

public String getDescription()

Deprecated.

Specified by:

getDescription in class Resource

Returns:

the resource description

setName

public Project setName(String name)

Deprecated.

For internal use only.

getLanguage

public Language getLanguage()

Deprecated.

Specified by:

getLanguage in class Resource

Returns:

the language of the resource. Only Files may have a non null value.

setDescription

public Project setDescription(String description)

Deprecated.

For internal use only.

isRoot

public boolean isRoot()

Deprecated.

Returns:

whether the current project is root project

getRoot

public Project getRoot()

Deprecated.

isModule

public boolean isModule()

Deprecated.

Returns:

whether the current project is a module

setLatestAnalysis

@Deprecated
public Project setLatestAnalysis(boolean b)

Deprecated. in 3.6. It's not possible to analyze a project before the latest known quality snapshot. See http://jira.sonarsource.com/browse/SONAR-4334

For internal use only.

getLanguageKey

@Deprecated
public String getLanguageKey()

Deprecated. since 4.2 use FileSystem.languages()

Returns:

the language key or empty if no language is specified

setSettings

public Project setSettings(Settings settings)

Deprecated.

Internal use

getSettings

@Deprecated
public Settings getSettings()

Deprecated. since 5.0

Internal use for backward compatibility. Settings should be retrieved as an IoC dependency.

setAnalysisDate

public Project setAnalysisDate(Date analysisDate)

Deprecated.

For internal use only.

setAnalysisVersion

public Project setAnalysisVersion(String analysisVersion)

Deprecated.

For internal use only.

getScope

public String getScope()

Deprecated.

Specified by:

getScope in class Resource

Returns:

the scope of the current object

getQualifier

public String getQualifier()

Deprecated.

Description copied from class: Resource

The qualifier tells the type of the resource. For example, it can be a File, a Class, a Project, a Unit Test...

Specified by:

getQualifier in class Resource

Returns:

the qualifier of the current object

See Also:

for the list of qualifiers, to find out if a resource if a class, a unit test,... from its qualifier

matchFilePattern

public boolean matchFilePattern(String antPattern)

Deprecated.

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

@CheckForNull
public Project getParent()

Deprecated.

Description copied from class: Resource

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

Return null if the parent is the current project (or module in case of multi-module).

Specified by:

getParent in class Resource

setParent

public Project setParent(Project parent)

Deprecated.

For internal use only.

removeFromParent

public void removeFromParent()

Deprecated.

For internal use only.

getModules

public List<Project> getModules()

Deprecated.

Returns:

the list of modules

getAnalysisVersion

public String getAnalysisVersion()

Deprecated.

Returns:

the current version of the project

getAnalysisDate

public Date getAnalysisDate()

Deprecated.

Returns:

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

createFromMavenIds

public static Project createFromMavenIds(String groupId,
                                         String artifactId)

Deprecated.

createFromMavenIds

public static Project createFromMavenIds(String groupId,
                                         String artifactId,
                                         @Nullable
                                         String branch)

Deprecated.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

key

public String key()

Deprecated.

Specified by:

key in interface Component

name

public String name()

Deprecated.

Specified by:

name in interface Component

path

public String path()

Deprecated.

Description copied from interface: Component

Path of the component relative to basedir of the parent module.

Specified by:

path in interface Component

Returns:

null if this component is not a child of a module

longName

public String longName()

Deprecated.

Specified by:

longName in interface Component

qualifier

public String qualifier()

Deprecated.

Specified by:

qualifier in interface Component

setBaseDir

public void setBaseDir(File baseDir)

Deprecated.