org.sonar.api.resources

Class Qualifiers

java.lang.Object

org.sonar.api.resources.Qualifiers

public final class Qualifiers
extends Object

The qualifier determines the exact type of a resource. Plugins can define their own qualifiers.

Since:

2.6

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTORY
static String	FILE
static String	LIBRARY Deprecated. since 5.2 No more design features
static String	MODULE Module of a multi-modules project.
static String	PROJECT Single project or root of multi-modules projects Scope is Scopes.PROJECT
static String	SUBVIEW Sub-views, defined in root views.
static String	UNIT_TEST_FILE
static String	VIEW Root views.

Method Summary

Modifier and Type	Method and Description
static boolean	isDirectory(Resource resource)
static boolean	isFile(Resource resource)
static boolean	isModule(Resource resource)
static boolean	isProject(Resource resource, boolean acceptModules)
static boolean	isSubview(Resource resource)
static boolean	isView(Resource resource, boolean acceptSubViews)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VIEW

public static final String VIEW

Root views. Scope of views is Scopes.PROJECT

See Also:

Constant Field Values

SUBVIEW

public static final String SUBVIEW

Sub-views, defined in root views. Scope of sub-views is Scopes.PROJECT

See Also:

Constant Field Values

LIBRARY

@Deprecated
public static final String LIBRARY

Deprecated. since 5.2 No more design features

Library, for example a JAR dependency of Java projects. Scope of libraries is Scopes.PROJECT

See Also:

Constant Field Values

PROJECT

public static final String PROJECT

Single project or root of multi-modules projects Scope is Scopes.PROJECT

See Also:

Constant Field Values

MODULE

public static final String MODULE

Module of a multi-modules project. It's sometimes called "sub-project". Scope of modules is Scopes.PROJECT

See Also:

Constant Field Values

DIRECTORY

public static final String DIRECTORY

See Also:

Constant Field Values

FILE

public static final String FILE

See Also:

Constant Field Values

UNIT_TEST_FILE

public static final String UNIT_TEST_FILE

See Also:

Constant Field Values

Method Detail

isView

public static boolean isView(Resource resource,
                             boolean acceptSubViews)

Parameters:

resource - not nullable

isSubview

public static boolean isSubview(Resource resource)

Parameters:

resource - not nullable

isProject

public static boolean isProject(Resource resource,
                                boolean acceptModules)

Parameters:

resource - not nullable

isModule

public static boolean isModule(Resource resource)

Parameters:

resource - not nullable

isDirectory

public static boolean isDirectory(Resource resource)

Parameters:

resource - not nullable

isFile

public static boolean isFile(Resource resource)

Parameters:

resource - not nullable