Package net.sourceforge.pmd.properties

Enum PropertyDescriptorField

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PropertyDescriptorField>
    public enum PropertyDescriptorField
extends java.lang.Enum<PropertyDescriptorField>
    Field names for parsing the properties out of the ruleset xml files. These are intended to be used as the keys to a map of fields to values. Most property descriptors can be built directly from such a map using their factory.
    Author:
    Brian Remedios
    See Also:
    RuleSetFactory, PropertyTypeId

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CHOICES
      Choices for enumerated properties.
      DEFAULT_INDEX
      Default index for enumerated properties.
      DEFAULT_VALUE
      The default value.
      DELIMITER
      For multi-valued properties, this defines the delimiter of the single values.
      DESCRIPTION
      The description of the property.
      LABELS
      Labels for enumerated properties.
      LEGAL_PACKAGES
      To limit the range of valid values, package names.
      MAX
      The maximum allowed value for numeric properties.
      MIN
      The minimum allowed value for numeric properties.
      NAME
      The name of the property.
      TYPE
      The type of the property.
      UI_ORDER
      The UI order.

    • Method Detail

      • values

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

      • valueOf

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

      • attributeName

        public java.lang.String attributeName()
        Returns the String name of this attribute.
        Returns:
        The attribute's name

      • toString

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