Enum Class PropertyType

java.lang.Object
java.lang.Enum<PropertyType>
com.puppycrawl.tools.checkstyle.PropertyType
All Implemented Interfaces:
Serializable, Comparable<PropertyType>, Constable

public enum PropertyType extends Enum<PropertyType>
Represents the custom property type used in documentation and configuration files.
  • Enum Constant Details

    • FILE

      public static final PropertyType FILE
      This property is a file.
    • LOCALE_COUNTRY

      public static final PropertyType LOCALE_COUNTRY
      This property is a string represents an ISO 3166 2-letter code.
    • LOCALE_LANGUAGE

      public static final PropertyType LOCALE_LANGUAGE
      This property is a string represents an ISO 639 code.
    • PATTERN

      public static final PropertyType PATTERN
      This property is a regular expression pattern.
    • STRING

      public static final PropertyType STRING
      This property is a string.
    • TOKEN_ARRAY

      public static final PropertyType TOKEN_ARRAY
      This property is a set of tokens.
  • Field Details

    • description

      private final String description
      The human-readable property description.
  • Constructor Details

    • PropertyType

      private PropertyType(String description)
      Creates a new PropertyType instance.
      Parameters:
      description - the human-readable property description
  • Method Details

    • values

      public static PropertyType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static PropertyType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getDescription

      public String getDescription()
      Returns the human-readable property description.
      Returns:
      human-readable property description