Package com.puppycrawl.tools.checkstyle.checks.naming

Enum AccessModifierOption

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AccessModifierOption>
    public enum AccessModifierOption
extends java.lang.Enum<AccessModifierOption>
    This enum represents access modifiers. Access modifiers names are taken from JLS: https://docs.oracle.com/javase/specs/jls/se8/html/jls-6.html#jls-6.6

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PACKAGE
      Package access modifier.
      PRIVATE
      Private access modifier.
      PROTECTED
      Protected access modifier.
      PUBLIC
      Public access modifier.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AccessModifierOption getInstance​(java.lang.String modifierName)
      Factory method which returns an AccessModifier instance that corresponds to the given access modifier name represented as a String.
      java.lang.String toString()  
      static AccessModifierOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AccessModifierOption[] 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

    • Method Detail

      • values

        public static AccessModifierOption[] 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 (AccessModifierOption c : AccessModifierOption.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AccessModifierOption 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<AccessModifierOption>

      • getInstance

        public static AccessModifierOption getInstance​(java.lang.String modifierName)
        Factory method which returns an AccessModifier instance that corresponds to the given access modifier name represented as a String. The access modifier name can be formatted both as lower case or upper case string. For example, passing PACKAGE or package as a modifier name will return PACKAGE.
        Parameters:
        modifierName - access modifier name represented as a String.
        Returns:
        the AccessModifier associated with given access modifier name.