E
- The type of the valuesjava.lang.Comparable<E>
, EnumeratedPropertyDescriptor<E,java.util.List<E>>
, MultiValuePropertyDescriptor<E>
, PropertyDescriptor<E>
public final class EnumeratedMultiProperty<E> extends java.lang.Object implements EnumeratedPropertyDescriptor<E,java.util.List<E>>
Modifier and Type | Class | Description |
---|---|---|
static class |
EnumeratedMultiProperty.EnumMultiPBuilder<E> |
DEFAULT_DELIMITER, DEFAULT_NUMERIC_DELIMITER
Constructor | Description |
---|---|
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 |
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 |
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.
|
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(java.util.List<V> values) |
Formats the object onto a string suitable for storage within the property map.
|
java.lang.String |
asString(E item) |
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) |
|
protected E |
createFrom(java.lang.String toParse) |
Parse a string and returns an instance of a single value (not a list).
|
protected java.lang.String |
defaultAsString() |
Returns a string representation of the default value.
|
java.util.List<V> |
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(java.util.List<E> values) |
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.
|
char |
multiValueDelimiter() |
Return the character being used to delimit multiple property values within a single string.
|
java.lang.String |
name() |
The name of the property without spaces as it serves as the key into the property map.
|
static <E> EnumeratedMultiProperty.EnumMultiPBuilder<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(V value) |
Checks a single value for a "missing value" error.
|
java.util.List<V> |
valueFrom(java.lang.String valueString) |
Returns the value represented by this string.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asDelimitedString, attributeValuesById, defaultValue, description, isDefinedExternally, isMultiValue, name, preferredRowCount, propertyErrorFor, uiOrder, valueFrom
@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)
EnumeratedMultiProperty(String, String, Map, List, Class, float)
. Will be removed in
7.0.0theName
- NametheDescription
- DescriptiontheLabels
- Labels of the choicestheChoices
- Values that can be chosenchoiceIndices
- Indices of the default valuesvalueType
- Type of the valuestheUIOrder
- UI order@Deprecated public EnumeratedMultiProperty(java.lang.String theName, java.lang.String theDescription, java.lang.String[] theLabels, E[] theChoices, int[] choiceIndices, float theUIOrder)
EnumeratedMultiProperty(String, String, Map, List, Class, float)
. Will be removed in
7.0.0theName
- NametheDescription
- DescriptiontheLabels
- Labels of the choicestheChoices
- Values that can be chosenchoiceIndices
- Indices of the default valuestheUIOrder
- UI orderpublic 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)
theName
- NametheDescription
- Descriptionchoices
- Map of labels to valuesdefaultValues
- List of default valuesvalueType
- Type of the valuestheUIOrder
- UI orderpublic java.util.Map<java.lang.String,E> mappings()
EnumeratedPropertyDescriptor
mappings
in interface EnumeratedPropertyDescriptor<E,java.util.List<E>>
public java.lang.Class<E> type()
PropertyDescriptor
type
in interface MultiValuePropertyDescriptor<E>
type
in interface PropertyDescriptor<E>
public java.lang.String errorFor(java.util.List<E> values)
PropertyDescriptor
errorFor
in interface PropertyDescriptor<E>
values
- The value to check.protected E createFrom(java.lang.String toParse)
toParse
- String to parsepublic java.lang.String asString(E item)
item
- The value to describepublic static <E> EnumeratedMultiProperty.EnumMultiPBuilder<E> named(java.lang.String name)
public final boolean isMultiValue()
PropertyDescriptor
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.
isMultiValue
in interface PropertyDescriptor<V>
public java.lang.String propertyErrorFor(Rule rule)
PropertyDescriptor
propertyErrorFor
in interface PropertyDescriptor<V>
rule
- Ruleprotected java.lang.String valueErrorFor(V value)
value
- Value to checkprotected java.lang.String defaultAsString()
public java.util.List<V> defaultValue()
PropertyDescriptor
defaultValue
in interface PropertyDescriptor<V>
public char multiValueDelimiter()
MultiValuePropertyDescriptor
multiValueDelimiter
in interface MultiValuePropertyDescriptor<V>
public final java.lang.String asDelimitedString(java.util.List<V> values)
PropertyDescriptor
asDelimitedString
in interface PropertyDescriptor<V>
values
- Objectpublic java.util.List<V> valueFrom(java.lang.String valueString) throws java.lang.IllegalArgumentException
PropertyDescriptor
valueFrom
in interface PropertyDescriptor<V>
valueString
- The string to parsejava.lang.IllegalArgumentException
- if the given string cannot be parsedprotected void addAttributesTo(java.util.Map<PropertyDescriptorField,java.lang.String> attributes)
PropertyDescriptorField
.attributes
- The map to fillpublic java.lang.String description()
PropertyDescriptor
description
in interface PropertyDescriptor<T>
public float uiOrder()
PropertyDescriptor
Example:
name -> 0.0 description 1.0 minValue -> 2.0 maxValue -> 2.1
name: [ ] description: [ ] minimum: [ ] maximum: [ ]
uiOrder
in interface PropertyDescriptor<T>
public final int compareTo(PropertyDescriptor<?> otherProperty)
compareTo
in interface java.lang.Comparable<T>
public int preferredRowCount()
PropertyDescriptor
preferredRowCount
in interface PropertyDescriptor<T>
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String name()
PropertyDescriptor
name
in interface PropertyDescriptor<T>
public final java.util.Map<PropertyDescriptorField,java.lang.String> attributeValuesById()
PropertyDescriptor
attributeValuesById
in interface PropertyDescriptor<T>
public boolean isDefinedExternally()
PropertyDescriptor
RuleSetWriter
to write out the property correctly: if it was defined externally, then its definition must be written out,
otherwise only its value.isDefinedExternally
in interface PropertyDescriptor<T>
Copyright © 2002–2018 PMD. All rights reserved.