Package net.sourceforge.pmd.properties

Class EnumeratedProperty<E>

  • Type Parameters:
    E - Type of the values
    All Implemented Interfaces:
    java.lang.Comparable<PropertyDescriptor<?>>, EnumeratedPropertyDescriptor<E,​E>, PropertyDescriptor<E>, SingleValuePropertyDescriptor<E>
    public final class EnumeratedProperty<E>
extends java.lang.Object
implements EnumeratedPropertyDescriptor<E,​E>
    Property which can take only a fixed set of values of any type, then selected via String labels. The mappings method returns the set of mappings between the labels and their values.

    This property currently doesn't support serialization and cannot be defined in a ruleset file.z

    Version:
    Refactored June 2017 (6.0.0)
    Author:
    Brian Remedios, Clément Fournier

    • Constructor Summary

      Constructors 
      Constructor Description
      EnumeratedProperty​(java.lang.String theName, java.lang.String theDescription, java.lang.String[] theLabels, E[] theChoices, int defaultIndex, float theUIOrder)
      Deprecated.
      will be removed in 7.0.0.
      EnumeratedProperty​(java.lang.String theName, java.lang.String theDescription, java.lang.String[] theLabels, E[] theChoices, int defaultIndex, java.lang.Class<E> valueType, float theUIOrder)
      Deprecated.
      will be removed in 7.0.0.
      EnumeratedProperty​(java.lang.String theName, java.lang.String theDescription, java.util.Map<java.lang.String,​E> labelsToChoices, E defaultValue, java.lang.Class<E> valueType, float theUIOrder)
      Constructor using a map to define the label-value mappings.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addAttributesTo​(java.util.Map<PropertyDescriptorField,​java.lang.String> attributes)
      Adds this property's attributes to the map.
      java.lang.String asDelimitedString​(T value)
      Formats the object onto a string suitable for storage within the property map.
      java.lang.String asString​(E value)
      Returns a string representation of the value, even if it's null.
      java.util.Map<PropertyDescriptorField,​java.lang.String> attributeValuesById()
      Returns a map representing all the property attributes of the receiver in string form.
      int compareTo​(PropertyDescriptor<?> otherProperty)  
      E createFrom​(java.lang.String value)
      Parse a string and returns an instance of a value.
      protected java.lang.String defaultAsString()
      Returns a string representation of the default value.
      T defaultValue()
      Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
      java.lang.String description()
      Describes the property and the role it plays within the rule it is specified for.
      boolean equals​(java.lang.Object obj)  
      java.lang.String errorFor​(E value)
      Validation function that returns a diagnostic error message for a sample property value.
      int hashCode()  
      boolean isDefinedExternally()
      True if this descriptor was defined in the ruleset xml.
      boolean isMultiValue()
      Returns whether the property is multi-valued, i.e.
      java.util.Map<java.lang.String,​E> mappings()
      Returns an immutable map of the label - value mappings defined by this descriptor.
      java.lang.String name()
      The name of the property without spaces as it serves as the key into the property map.
      static <E> EnumeratedProperty.EnumPBuilder<E> named​(java.lang.String name)  
      int preferredRowCount()
      If the datatype is a String then return the preferred number of rows to allocate in the text widget, returns a value of one for all other types.
      java.lang.String propertyErrorFor​(Rule rule)
      A convenience method that returns an error string if the rule holds onto a property value that has a problem.
      java.lang.String toString()  
      java.lang.Class<E> type()
      Denotes the value datatype.
      float uiOrder()
      Denotes the relative order the property field should occupy if we are using an auto-generated UI to display and edit property values.
      protected java.lang.String valueErrorFor​(T value)
      Checks the value for an error.
      T valueFrom​(java.lang.String valueString)
      Returns the value represented by this string.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface java.lang.Comparable

        compareTo

    • Constructor Detail

      • EnumeratedProperty

        @Deprecated
public EnumeratedProperty​(java.lang.String theName,
                          java.lang.String theDescription,
                          java.lang.String[] theLabels,
                          E[] theChoices,
                          int defaultIndex,
                          java.lang.Class<E> valueType,
                          float theUIOrder)
        Deprecated.
        will be removed in 7.0.0. Use EnumeratedProperty(String, String, Map, Object, Class, float)
        Constructor using arrays to define the label-value mappings. The correct construction of the property depends on the correct ordering of the arrays.
        Parameters:
        theName - Name
        theDescription - Description
        theLabels - Labels of the choices
        theChoices - Values that can be chosen
        defaultIndex - The index of the default value
        valueType - Type of the values
        theUIOrder - UI order

      • EnumeratedProperty

        @Deprecated
public EnumeratedProperty​(java.lang.String theName,
                          java.lang.String theDescription,
                          java.lang.String[] theLabels,
                          E[] theChoices,
                          int defaultIndex,
                          float theUIOrder)
        Deprecated.
        will be removed in 7.0.0. Use EnumeratedProperty(String, String, Map, Object, Class, float)
        Constructor using arrays to define the label-value mappings. The correct construction of the property depends on the correct ordering of the arrays.
        Parameters:
        theName - Name
        theDescription - Description
        theLabels - Labels of the choices
        theChoices - Values that can be chosen
        defaultIndex - Index of the default value
        theUIOrder - UI order

      • EnumeratedProperty

        public EnumeratedProperty​(java.lang.String theName,
                          java.lang.String theDescription,
                          java.util.Map<java.lang.String,​E> labelsToChoices,
                          E defaultValue,
                          java.lang.Class<E> valueType,
                          float theUIOrder)
        Constructor using a map to define the label-value mappings.
        Parameters:
        theName - Name
        theDescription - Description
        labelsToChoices - Map of labels to values
        defaultValue - Default value
        valueType - Type of the values
        theUIOrder - UI order

    • Method Detail

      • errorFor

        public java.lang.String errorFor​(E value)
        Description copied from interface: PropertyDescriptor
        Validation function that returns a diagnostic error message for a sample property value. Returns null if the value is acceptable.
        Specified by:
        errorFor in interface PropertyDescriptor<E>
        Parameters:
        value - The value to check.
        Returns:
        A diagnostic message.

      • createFrom

        public E createFrom​(java.lang.String value)
             throws java.lang.IllegalArgumentException
        Parse a string and returns an instance of a value.
        Parameters:
        value - String to parse
        Returns:
        An instance of a value
        Throws:
        java.lang.IllegalArgumentException

      • asString

        public java.lang.String asString​(E value)
        Returns a string representation of the value, even if it's null.
        Parameters:
        value - The value to describe
        Returns:
        A string representation of the value

      • mappings

        public java.util.Map<java.lang.String,​E> mappings()
        Description copied from interface: EnumeratedPropertyDescriptor
        Returns an immutable map of the label - value mappings defined by this descriptor.
        Specified by:
        mappings in interface EnumeratedPropertyDescriptor<E,​E>
        Returns:
        an immutable map of the label - value mappings defined by this descriptor.

      • defaultValue

        public final T defaultValue()
        Description copied from interface: PropertyDescriptor
        Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
        Specified by:
        defaultValue in interface PropertyDescriptor<T>
        Returns:
        Object

      • isMultiValue

        public final boolean isMultiValue()
        Description copied from interface: PropertyDescriptor
        Returns whether the property is multi-valued, i.e. an array of strings,

        As unary property rule properties will return a value of one, you must use the get/setProperty accessors when working with the actual values. When working with multi-value properties then the get/setProperties accessors must be used.

        Specified by:
        isMultiValue in interface PropertyDescriptor<T>
        Returns:
        boolean

      • asDelimitedString

        public java.lang.String asDelimitedString​(T value)
        Description copied from interface: PropertyDescriptor
        Formats the object onto a string suitable for storage within the property map.
        Specified by:
        asDelimitedString in interface PropertyDescriptor<T>
        Parameters:
        value - Object
        Returns:
        String

      • propertyErrorFor

        public java.lang.String propertyErrorFor​(Rule rule)
        Description copied from interface: PropertyDescriptor
        A convenience method that returns an error string if the rule holds onto a property value that has a problem. Returns null otherwise.
        Specified by:
        propertyErrorFor in interface PropertyDescriptor<T>
        Parameters:
        rule - Rule
        Returns:
        String

      • valueErrorFor

        protected java.lang.String valueErrorFor​(T value)
        Checks the value for an error.
        Parameters:
        value - Value to check
        Returns:
        A diagnostic error message, or null if there's no problem

      • defaultAsString

        protected final java.lang.String defaultAsString()
        Returns a string representation of the default value.
        Returns:
        A string representation of the default value.

      • valueFrom

        public final T valueFrom​(java.lang.String valueString)
                  throws java.lang.IllegalArgumentException
        Description copied from interface: PropertyDescriptor
        Returns the value represented by this string.
        Specified by:
        valueFrom in interface PropertyDescriptor<T>
        Parameters:
        valueString - The string to parse
        Returns:
        The value represented by the string
        Throws:
        java.lang.IllegalArgumentException - if the given string cannot be parsed

      • description

        public java.lang.String description()
        Description copied from interface: PropertyDescriptor
        Describes the property and the role it plays within the rule it is specified for. Could be used in a tooltip.
        Specified by:
        description in interface PropertyDescriptor<T>
        Returns:
        String

      • uiOrder

        public float uiOrder()
        Description copied from interface: PropertyDescriptor
        Denotes the relative order the property field should occupy if we are using an auto-generated UI to display and edit property values. If the value returned has a non-zero fractional part then this is can be used to place adjacent fields on the same row.

        Example:
        name -> 0.0 description 1.0 minValue -> 2.0 maxValue -> 2.1

        ..would have their fields placed like:
        name: [ ] description: [ ] minimum: [ ] maximum: [ ]
        Specified by:
        uiOrder in interface PropertyDescriptor<T>
        Returns:
        float

      • compareTo

        public final int compareTo​(PropertyDescriptor<?> otherProperty)
        Specified by:
        compareTo in interface java.lang.Comparable<T>

      • preferredRowCount

        public int preferredRowCount()
        Description copied from interface: PropertyDescriptor
        If the datatype is a String then return the preferred number of rows to allocate in the text widget, returns a value of one for all other types. Useful for multi-line XPATH editors.
        Specified by:
        preferredRowCount in interface PropertyDescriptor<T>
        Returns:
        int

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • name

        public java.lang.String name()
        Description copied from interface: PropertyDescriptor
        The name of the property without spaces as it serves as the key into the property map.
        Specified by:
        name in interface PropertyDescriptor<T>
        Returns:
        String

      • addAttributesTo

        protected void addAttributesTo​(java.util.Map<PropertyDescriptorField,​java.lang.String> attributes)
        Adds this property's attributes to the map. Subclasses can override this to add more PropertyDescriptorField.
        Parameters:
        attributes - The map to fill

      • isDefinedExternally

        public boolean isDefinedExternally()
        Description copied from interface: PropertyDescriptor
        True if this descriptor was defined in the ruleset xml. This precision is necessary for the RuleSetWriter to write out the property correctly: if it was defined externally, then its definition must be written out, otherwise only its value.
        Specified by:
        isDefinedExternally in interface PropertyDescriptor<T>
        Returns:
        True if the descriptor was defined in xml