org.sonar.api.resources
Interface Resource<PARENT extends Resource<?>>

All Known Implementing Classes:

AbstractResource, Directory, File, JavaClass, JavaPackage, Project

public interface Resource<PARENT extends Resource<?>>

Field Summary

static java.lang.String	QUALIFIER_CLASS
static java.lang.String	QUALIFIER_DIRECTORY
static java.lang.String	QUALIFIER_FILE
static java.lang.String	QUALIFIER_PACKAGE
static java.lang.String	QUALIFIER_PROJECT_BRANCH
static java.lang.String	QUALIFIER_PROJECT_TRUNK
static java.lang.String	QUALIFIER_UNIT_TEST_CLASS
static java.lang.String	SCOPE_DIRECTORY
static java.lang.String	SCOPE_FILE
static java.lang.String	SCOPE_FUNCTION Not used yet.
static java.lang.String	SCOPE_PROJECT

Method Summary

java.lang.String	getDescription()
java.lang.String	getKey()
java.lang.String	getLanguage()
java.lang.String	getName()
PARENT	getParent() The parent is used to build the resources tree, for example for relations between classes, packages and projects.
java.lang.String	getQualifier()
java.lang.String	getScope()
boolean	matchFilePattern(java.lang.String antPattern) Check resource against an Ant pattern, like mypackag?/*Foo.java.

Field Detail

SCOPE_PROJECT

static final java.lang.String SCOPE_PROJECT

See Also:

Constant Field Values

SCOPE_DIRECTORY

static final java.lang.String SCOPE_DIRECTORY

See Also:

Constant Field Values

SCOPE_FILE

static final java.lang.String SCOPE_FILE

See Also:

Constant Field Values

SCOPE_FUNCTION

static final java.lang.String SCOPE_FUNCTION

Not used yet.

See Also:

Constant Field Values

QUALIFIER_PROJECT_TRUNK

static final java.lang.String QUALIFIER_PROJECT_TRUNK

See Also:

Constant Field Values

QUALIFIER_PROJECT_BRANCH

static final java.lang.String QUALIFIER_PROJECT_BRANCH

See Also:

Constant Field Values

QUALIFIER_PACKAGE

static final java.lang.String QUALIFIER_PACKAGE

See Also:

Constant Field Values

QUALIFIER_DIRECTORY

static final java.lang.String QUALIFIER_DIRECTORY

See Also:

Constant Field Values

QUALIFIER_FILE

static final java.lang.String QUALIFIER_FILE

See Also:

Constant Field Values

QUALIFIER_CLASS

static final java.lang.String QUALIFIER_CLASS

See Also:

Constant Field Values

QUALIFIER_UNIT_TEST_CLASS

static final java.lang.String QUALIFIER_UNIT_TEST_CLASS

See Also:

Constant Field Values

Method Detail

getKey

java.lang.String getKey()

getName

java.lang.String getName()

getDescription

java.lang.String getDescription()

getLanguage

java.lang.String getLanguage()

getScope

java.lang.String getScope()

getQualifier

java.lang.String getQualifier()

getParent

PARENT getParent()

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.

matchFilePattern

boolean matchFilePattern(java.lang.String antPattern)

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

Parameters:

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

Returns:

true if the resource matches the Ant pattern