Package org.sonar.api.resources

Class Scopes

  • @Deprecated(since="10.13",
            forRemoval=true)
public final class Scopes
extends java.lang.Object
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 10.13. Scopes are not used when developing plugins. This is exposed in some web APIs, but it doesn't make sense to make it part of the plugin API.
    Resource scopes are used to group some types of resources. For example Java methods, Flex methods, C functions and Cobol paragraphs are grouped in the scope "block unit".
    Scopes are generally used in UI to display/hide some services or in web services.
    Scopes are not extensible by plugins.
    Since:
    2.6

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DIRECTORY
      Deprecated, for removal: This API element is subject to removal in a future version.
      For example directory or Java package.
      static java.lang.String FILE
      Deprecated, for removal: This API element is subject to removal in a future version.
      For example a Java file.
      static java.lang.String PROJECT
      Deprecated, for removal: This API element is subject to removal in a future version.
      For example view, subview, project, module or library.
      static java.lang.String[] SORTED_SCOPES
      Deprecated, for removal: This API element is subject to removal in a future version.
       

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean isHigherThan​(java.lang.String scope, java.lang.String than)
      Deprecated, for removal: This API element is subject to removal in a future version.
       
      static boolean isHigherThanOrEquals​(java.lang.String scope, java.lang.String than)
      Deprecated, for removal: This API element is subject to removal in a future version.
       

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • PROJECT

        public static final java.lang.String PROJECT
        Deprecated, for removal: This API element is subject to removal in a future version.
        For example view, subview, project, module or library. Persisted in database.
        See Also:
        Constant Field Values

      • DIRECTORY

        public static final java.lang.String DIRECTORY
        Deprecated, for removal: This API element is subject to removal in a future version.
        For example directory or Java package. Persisted in database. A more generic term for this scope could be "namespace"
        See Also:
        Constant Field Values

      • FILE

        public static final java.lang.String FILE
        Deprecated, for removal: This API element is subject to removal in a future version.
        For example a Java file. Persisted in database. A more generic term for this scope could be "compilation unit". It's the lowest scope in file system units.
        See Also:
        Constant Field Values

      • SORTED_SCOPES

        public static final java.lang.String[] SORTED_SCOPES
        Deprecated, for removal: This API element is subject to removal in a future version.

    • Method Detail

      • isHigherThan

        public static boolean isHigherThan​(java.lang.String scope,
                                   java.lang.String than)
        Deprecated, for removal: This API element is subject to removal in a future version.

      • isHigherThanOrEquals

        public static boolean isHigherThanOrEquals​(java.lang.String scope,
                                           java.lang.String than)
        Deprecated, for removal: This API element is subject to removal in a future version.