org.sonar.api.resources
Class Qualifiers

java.lang.Object
  extended by 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
static String CLASS
          Deprecated. since 4.2 now java files are considered as regular files. Use FILE instead.
static String DIRECTORY
           
static String FIELD
          Deprecated. since 4.2 resources under FILE level will no more be supported.
static String FILE
           
static String LIBRARY
          Library, for example a JAR dependency of Java projects.
static String METHOD
          Deprecated. since 4.2 resources under FILE level will no more be supported.
static String MODULE
          Module of a multi-modules project.
static String PACKAGE
          Deprecated. since 4.2 now packages are considered as regular directories. Use DIRECTORY instead.
static String PARAGRAPH
          Deprecated. since 4.2 resources under FILE level will no more be supported.
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
static boolean isClass(Resource resource)
          Deprecated. since 4.2 CLA qualifier is deprecated
static boolean isDirectory(Resource resource)
           
static boolean isFile(Resource resource)
           
static boolean isMethod(Resource resource)
           
static boolean isModule(Resource resource)
           
static boolean isPackage(Resource resource)
          Deprecated. since 4.2 Package is now a directory. Use isDirectory(Resource)
static boolean isParagraph(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

public static final String LIBRARY
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

PACKAGE

@Deprecated
public static final String PACKAGE
Deprecated. since 4.2 now packages are considered as regular directories. Use DIRECTORY instead.
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

CLASS

@Deprecated
public static final String CLASS
Deprecated. since 4.2 now java files are considered as regular files. Use FILE instead.
See Also:
Constant Field Values

PARAGRAPH

@Deprecated
public static final String PARAGRAPH
Deprecated. since 4.2 resources under FILE level will no more be supported.
See Also:
Constant Field Values

METHOD

@Deprecated
public static final String METHOD
Deprecated. since 4.2 resources under FILE level will no more be supported.
See Also:
Constant Field Values

FIELD

@Deprecated
public static final String FIELD
Deprecated. since 4.2 resources under FILE level will no more be supported.
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

isPackage

@Deprecated
public static boolean isPackage(Resource resource)
Deprecated. since 4.2 Package is now a directory. Use isDirectory(Resource)


isFile

public static boolean isFile(Resource resource)
Parameters:
resource - not nullable

isClass

@Deprecated
public static boolean isClass(Resource resource)
Deprecated. since 4.2 CLA qualifier is deprecated

Parameters:
resource - not nullable

isMethod

public static boolean isMethod(Resource resource)
Parameters:
resource - not nullable

isParagraph

public static boolean isParagraph(Resource resource)
Parameters:
resource - not nullable


Copyright © 2009-2014 SonarSource. All Rights Reserved.