Package net.sourceforge.pmd.properties
Interface MultiValuePropertyDescriptor<V>
-
- Type Parameters:
V
- The type of value this descriptor works with. This is the type of the list's component.
- All Superinterfaces:
java.lang.Comparable<PropertyDescriptor<?>>
,PropertyDescriptor<java.util.List<V>>
- All Known Implementing Classes:
BooleanMultiProperty
,CharacterMultiProperty
,DoubleMultiProperty
,EnumeratedMultiProperty
,FloatMultiProperty
,IntegerMultiProperty
,LongMultiProperty
,MethodMultiProperty
,StringMultiProperty
,TypeMultiProperty
public interface MultiValuePropertyDescriptor<V> extends PropertyDescriptor<java.util.List<V>>
Specializes property descriptors for multi valued descriptors. For this type of property, the return value of thetype()
method must be the class literal of the type parameter of this interface, which is the type of the components of the list (not the type of the list). Notice that for implementors, the type parameter of this interface is not the same as the type parameter ofPropertyDescriptor
they inherit!- Since:
- 6.0.0
- Author:
- Clément Fournier
-
-
Field Summary
Fields Modifier and Type Field Description static char
DEFAULT_DELIMITER
Default delimiter for multi-valued properties other than numeric ones.static char
DEFAULT_NUMERIC_DELIMITER
Default delimiter for numeric multi-valued properties.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description char
multiValueDelimiter()
Return the character being used to delimit multiple property values within a single string.java.lang.Class<V>
type()
Denotes the value datatype.-
Methods inherited from interface net.sourceforge.pmd.properties.PropertyDescriptor
asDelimitedString, attributeValuesById, defaultValue, description, errorFor, isDefinedExternally, isMultiValue, name, preferredRowCount, propertyErrorFor, uiOrder, valueFrom
-
-
-
-
Field Detail
-
DEFAULT_DELIMITER
static final char DEFAULT_DELIMITER
Default delimiter for multi-valued properties other than numeric ones.- See Also:
- Constant Field Values
-
DEFAULT_NUMERIC_DELIMITER
static final char DEFAULT_NUMERIC_DELIMITER
Default delimiter for numeric multi-valued properties.- See Also:
- Constant Field Values
-
-
Method Detail
-
multiValueDelimiter
char multiValueDelimiter()
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.- Returns:
- char
-
type
java.lang.Class<V> type()
Description copied from interface:PropertyDescriptor
Denotes the value datatype. For multi value properties, this is not the List class but the list's component class.- Specified by:
type
in interfacePropertyDescriptor<V>
- Returns:
- Class literal of the value type
-
-