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 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(DefaultInputModule module) Deprecated.
Project(ProjectDefinition definition) Deprecated.

Method Summary

Modifier and Type	Method and Description
ProjectDefinition	definition() Deprecated.
String	getBranch() Deprecated.
String	getDescription() Deprecated.
Language	getLanguage() Deprecated. since 4.2 use FileSystem.languages()
String	getLongName() Deprecated.
List<Project>	getModules() Deprecated.
String	getName() Deprecated.
String	getOriginalName() 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.
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.
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

Constructor Detail

Project

public Project(DefaultInputModule module)

Deprecated.

Project

public Project(ProjectDefinition definition)

Deprecated.

Method Detail

definition

public ProjectDefinition definition()

Deprecated.

key

public String key()

Deprecated.

Specified by:

key 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

getBranch

public String getBranch()

Deprecated.

getOriginalName

@CheckForNull
public String getOriginalName()

Deprecated.

name

public String name()

Deprecated.

Specified by:

name in interface Component

longName

public String longName()

Deprecated.

Specified by:

longName in interface Component

qualifier

public String qualifier()

Deprecated.

Specified by:

qualifier in interface Component

getName

public String getName()

Deprecated.

Specified by:

getName in class Resource

Returns:

the resource name

isRoot

public boolean isRoot()

Deprecated.

getRoot

public Project getRoot()

Deprecated.

isModule

public boolean isModule()

Deprecated.

Returns:

whether the current project is a module

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

getLanguage

public Language getLanguage()

Deprecated. since 4.2 use FileSystem.languages()

Specified by:

getLanguage in class Resource

Returns:

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

getScope

public String getScope()

Deprecated.

Specified by:

getScope in class Resource

Returns:

the scope

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

See Also:

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

getParent

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

getModules

public List<Project> getModules()

Deprecated.

Returns:

the list of modules

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

toString

public String toString()

Deprecated.

Overrides:

toString in class Object