Package com.puppycrawl.tools.checkstyle.api

Enum Scope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Scope>
    public enum Scope
extends java.lang.Enum<Scope>
    Represents a Java visibility scope.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Scope getInstance​(java.lang.String scopeName)
      Scope factory method.
      java.lang.String getName()
      Returns name of severity level.
      boolean isIn​(Scope scope)
      Checks if this scope is a subscope of another scope.
      java.lang.String toString()  
      static Scope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Scope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NOTHING

        public static final Scope NOTHING
        Nothing scope.

      • PUBLIC

        public static final Scope PUBLIC
        Public scope.

      • PROTECTED

        public static final Scope PROTECTED
        Protected scope.

      • PACKAGE

        public static final Scope PACKAGE
        Package or default scope.

      • PRIVATE

        public static final Scope PRIVATE
        Private scope.

      • ANONINNER

        public static final Scope ANONINNER
        Anonymous inner scope.

    • Method Detail

      • values

        public static Scope[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Scope c : Scope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Scope valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<Scope>

      • getName

        public java.lang.String getName()
        Returns name of severity level.
        Returns:
        the name of this severity level.

      • isIn

        public boolean isIn​(Scope scope)
        Checks if this scope is a subscope of another scope. Example: PUBLIC is a subscope of PRIVATE.
        Parameters:
        scope - a Scope value
        Returns:
        if this is a subscope of scope.

      • getInstance

        public static Scope getInstance​(java.lang.String scopeName)
        Scope factory method.
        Parameters:
        scopeName - scope name, such as "nothing", "public", etc.
        Returns:
        the Scope associated with scopeName