Package net.sourceforge.pmd.properties

Class EnumeratedMultiProperty<E>

  • Type Parameters:
    E - The type of the values
    All Implemented Interfaces:
    java.lang.Comparable<PropertyDescriptor<?>>, EnumeratedPropertyDescriptor<E,java.util.List<E>>, MultiValuePropertyDescriptor<E>, PropertyDescriptor<java.util.List<E>>
    public final class EnumeratedMultiProperty<E>
extends java.lang.Object
implements EnumeratedPropertyDescriptor<E,java.util.List<E>>
    Multi-valued 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.
    Version:
    Refactored June 2017 (6.0.0)
    Author:
    Brian Remedios, Clément Fournier

    • Constructor Detail

      • EnumeratedMultiProperty

        @Deprecated
public EnumeratedMultiProperty​(java.lang.String theName,
                               java.lang.String theDescription,
                               java.lang.String[] theLabels,
                               E[] theChoices,
                               int[] choiceIndices,
                               java.lang.Class<E> valueType,
                               float theUIOrder)
        Deprecated.
        Use EnumeratedMultiProperty(String, String, Map, List, Class, float). Will be removed in 7.0.0
        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
        choiceIndices - Indices of the default values
        valueType - Type of the values
        theUIOrder - UI order

      • EnumeratedMultiProperty

        @Deprecated
public EnumeratedMultiProperty​(java.lang.String theName,
                               java.lang.String theDescription,
                               java.lang.String[] theLabels,
                               E[] theChoices,
                               int[] choiceIndices,
                               float theUIOrder)
        Deprecated.
        Use EnumeratedMultiProperty(String, String, Map, List, Class, float). Will be removed in 7.0.0
        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
        choiceIndices - Indices of the default values
        theUIOrder - UI order

      • EnumeratedMultiProperty

        public EnumeratedMultiProperty​(java.lang.String theName,
                               java.lang.String theDescription,
                               java.util.Map<java.lang.String,E> choices,
                               java.util.List<E> defaultValues,
                               java.lang.Class<E> valueType,
                               float theUIOrder)
        Constructor using a map to define the label-value mappings. The default values are specified with a list.
        Parameters:
        theName - Name
        theDescription - Description
        choices - Map of labels to values
        defaultValues - List of default values
        valueType - Type of the values
        theUIOrder - UI order

    • Method Detail

      • 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,java.util.List<E>>
        Returns:
        an immutable map of the label - value mappings defined by this descriptor.

      • errorFor

        public java.lang.String errorFor​(java.util.List<E> values)
        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:
        values - The value to check.
        Returns:
        A diagnostic message.

      • createFrom

        protected E createFrom​(java.lang.String toParse)
        Parse a string and returns an instance of a single value (not a list).
        Parameters:
        toParse - String to parse
        Returns:
        An instance of a value

      • asString

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

      • 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<V>
        Returns:
        boolean

      • 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<V>
        Parameters:
        rule - Rule
        Returns:
        String

      • valueErrorFor

        protected java.lang.String valueErrorFor​(V value)
        Checks a single value for a "missing value" error.
        Parameters:
        value - Value to check
        Returns:
        A descriptive String of the error or null if there was none

      • defaultAsString

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

      • defaultValue

        public java.util.List<V> 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<V>
        Returns:
        Object

      • multiValueDelimiter

        public char multiValueDelimiter()
        Description copied from interface: MultiValuePropertyDescriptor
        Return the character being used to delimit multiple property values within a single string. You must ensure that this character does not appear within any rule property values to avoid deserialization errors.
        Specified by:
        multiValueDelimiter in interface MultiValuePropertyDescriptor<V>
        Returns:
        char

      • asDelimitedString

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

      • valueFrom

        public java.util.List<V> 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<V>
        Parameters:
        valueString - The string to parse
        Returns:
        The value represented by the string
        Throws:
        java.lang.IllegalArgumentException - if the given string cannot be parsed

      • 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

      • 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

      • 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