Package org.sonar.api.resources

Class Scopes

  • public final class Scopes
extends java.lang.Object
    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 BLOCK_UNIT
      Deprecated.
      since 4.3 resources under FILE level are no more be supported since 4.2.
      static java.lang.String DIRECTORY
      For example directory or Java package.
      static java.lang.String FILE
      For example a Java file.
      static java.lang.String PROGRAM_UNIT
      Deprecated.
      since 4.3 resources under FILE level are no more be supported since 4.2.
      static java.lang.String PROJECT
      For example view, subview, project, module or library.
      static java.lang.String[] SORTED_SCOPES  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean isHigherThan​(java.lang.String scope, java.lang.String than)  
      static boolean isHigherThanOrEquals​(java.lang.String scope, java.lang.String than)  

      • 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
        For example view, subview, project, module or library. Persisted in database.
        See Also:
        Constant Field Values

      • DIRECTORY

        public static final java.lang.String DIRECTORY
        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
        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

      • PROGRAM_UNIT

        @Deprecated
public static final java.lang.String PROGRAM_UNIT
        Deprecated.
        since 4.3 resources under FILE level are no more be supported since 4.2.
        Types like Java classes/interfaces. Not persisted in database.
        See Also:
        Constant Field Values

      • BLOCK_UNIT

        @Deprecated
public static final java.lang.String BLOCK_UNIT
        Deprecated.
        since 4.3 resources under FILE level are no more be supported since 4.2.
        Block units like methods, functions or Cobol paragraphs.
        See Also:
        Constant Field Values

      • SORTED_SCOPES

        public static final java.lang.String[] SORTED_SCOPES

    • Method Detail

      • isHigherThan

        public static boolean isHigherThan​(java.lang.String scope,
                                   java.lang.String than)

      • isHigherThanOrEquals

        public static boolean isHigherThanOrEquals​(java.lang.String scope,
                                           java.lang.String than)