Package com.puppycrawl.tools.checkstyle.meta

Enum ModuleType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ModuleType>
    public enum ModuleType
extends java.lang.Enum<ModuleType>
    Enum holding the types of module which can exist.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CHECK
      Module is a Checkstyle check.
      FILEFILTER
      Module is a Checkstyle file filter.
      FILTER
      Module is a Checkstyle filter.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLabel()
      Get label corresponding to a module type.
      static ModuleType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ModuleType[] 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, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • CHECK

        public static final ModuleType CHECK
        Module is a Checkstyle check.

      • FILTER

        public static final ModuleType FILTER
        Module is a Checkstyle filter.

      • FILEFILTER

        public static final ModuleType FILEFILTER
        Module is a Checkstyle file filter.

    • Method Detail

      • values

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

      • valueOf

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

      • getLabel

        public java.lang.String getLabel()
        Get label corresponding to a module type.
        Returns:
        module type label