public abstract class AbstractPMDProperty extends java.lang.Object implements PropertyDescriptor
Modifier and Type | Field and Description |
---|---|
protected char |
multiValueDelimiter |
emptyPropertySet
Modifier | Constructor and Description |
---|---|
protected |
AbstractPMDProperty(java.lang.String theName,
java.lang.String theDescription,
java.lang.Object theDefault,
float theUIOrder)
Constructor for AbstractPMDProperty.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
areEqual(java.lang.Object value,
java.lang.Object otherValue)
Method areEqual.
|
java.lang.String |
asDelimitedString(java.lang.Object values)
Method asDelimitedString.
|
protected java.lang.String |
asString(java.lang.Object value)
Return the value as a string that can be easily recognized and parsed
when we see it again.
|
java.lang.Object[][] |
choices()
Method choices.
|
int |
compareTo(PropertyDescriptor otherProperty)
Method compareTo.
|
java.lang.Object |
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()
Method description.
|
java.lang.String |
errorFor(java.lang.Object value)
Method errorFor.
|
protected boolean |
isArray(java.lang.Object value)
Method isArray.
|
boolean |
isRequired()
Method isRequired.
|
int |
maxValueCount()
Method maxValueCount.
|
protected void |
maxValueCount(int theCount)
Method maxValueCount.
|
char |
multiValueDelimiter()
Method multiValueDelimiter.
|
protected void |
multiValueDelimiter(char aDelimiter)
Method multiValueDelimiter.
|
java.lang.String |
name()
Method name.
|
int |
preferredRowCount()
Method preferredRowCount.
|
java.lang.String |
propertyErrorFor(Rule rule)
Method propertyErrorFor.
|
protected java.lang.String |
typeErrorFor(java.lang.Object value)
Method typeErrorFor.
|
float |
uiOrder()
Method uiOrder.
|
protected java.lang.String |
valueErrorFor(java.lang.Object value)
Method valueErrorFor.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
type, valueFrom
protected AbstractPMDProperty(java.lang.String theName, java.lang.String theDescription, java.lang.Object theDefault, float theUIOrder)
theName
- StringtheDescription
- StringtheDefault
- ObjecttheUIOrder
- floatprotected void multiValueDelimiter(char aDelimiter)
aDelimiter
- charpublic char multiValueDelimiter()
multiValueDelimiter
in interface PropertyDescriptor
PropertyDescriptor.multiValueDelimiter()
public java.lang.String name()
name
in interface PropertyDescriptor
PropertyDescriptor.name()
public java.lang.String description()
description
in interface PropertyDescriptor
PropertyDescriptor.description()
public java.lang.Object defaultValue()
PropertyDescriptor
defaultValue
in interface PropertyDescriptor
PropertyDescriptor.defaultValue()
public int maxValueCount()
maxValueCount
in interface PropertyDescriptor
PropertyDescriptor.maxValueCount()
protected void maxValueCount(int theCount)
theCount
- intPropertyDescriptor.maxValueCount()
public boolean isRequired()
isRequired
in interface PropertyDescriptor
PropertyDescriptor.isRequired()
public float uiOrder()
uiOrder
in interface PropertyDescriptor
PropertyDescriptor.uiOrder()
protected java.lang.String asString(java.lang.Object value)
value
- Objectpublic java.lang.String asDelimitedString(java.lang.Object values)
asDelimitedString
in interface PropertyDescriptor
values
- ObjectPropertyDescriptor.asDelimitedString(Object)
public int compareTo(PropertyDescriptor otherProperty)
compareTo
in interface java.lang.Comparable<PropertyDescriptor>
otherProperty
- ObjectComparable.compareTo(Object)
public java.lang.String errorFor(java.lang.Object value)
errorFor
in interface PropertyDescriptor
value
- ObjectPropertyDescriptor.errorFor(Object)
protected java.lang.String valueErrorFor(java.lang.Object value)
value
- Objectprotected boolean isArray(java.lang.Object value)
value
- Objectprotected java.lang.String typeErrorFor(java.lang.Object value)
value
- Objectpublic java.lang.String propertyErrorFor(Rule rule)
propertyErrorFor
in interface PropertyDescriptor
rule
- RulePropertyDescriptor.propertyErrorFor(Rule)
public java.lang.Object[][] choices()
choices
in interface PropertyDescriptor
PropertyDescriptor.choices()
public int preferredRowCount()
preferredRowCount
in interface PropertyDescriptor
PropertyDescriptor.preferredRowCount()
public static final boolean areEqual(java.lang.Object value, java.lang.Object otherValue)
value
- ObjectotherValue
- Object