net.sourceforge.pmd.properties

Class StringProperty

public class StringProperty extends AbstractPMDProperty

Defines a datatype that supports String values. When capturing multiple values, all strings must be filtered by the delimiter character.

Version: $Revision$

Author: Brian Remedios

Field Summary
static chardefaultDelimiter
Constructor Summary
StringProperty(String theName, String theDescription, String theDefaultValue, float theUIOrder)
Constructor for StringProperty.
StringProperty(String theName, String theDescription, String[] theValues, float theUIOrder, char aMultiValueDelimiter)
Constructor for StringProperty.
protected StringProperty(String theName, String theDescription, Object theDefaultValue, float theUIOrder, char aMultiValueDelimiter)
Constructor for StringProperty.
Method Summary
intpreferredRowCount()
Class<?>type()
Method type.
protected StringvalueErrorFor(Object value)
ObjectvalueFrom(String valueString)
Method valueFrom.

Field Detail

defaultDelimiter

public static final char defaultDelimiter

Constructor Detail

StringProperty

public StringProperty(String theName, String theDescription, String theDefaultValue, float theUIOrder)
Constructor for StringProperty.

Parameters: theName String theDescription String theDefaultValue String theUIOrder float

StringProperty

public StringProperty(String theName, String theDescription, String[] theValues, float theUIOrder, char aMultiValueDelimiter)
Constructor for StringProperty.

Parameters: theName String theDescription String theValues String[] theUIOrder float aMultiValueDelimiter String

StringProperty

protected StringProperty(String theName, String theDescription, Object theDefaultValue, float theUIOrder, char aMultiValueDelimiter)
Constructor for StringProperty.

Parameters: theName String theDescription String theDefaultValue Object theUIOrder float aMultiValueDelimiter String

Method Detail

preferredRowCount

public int preferredRowCount()

type

public Class<?> type()
Method type.

Returns: Class

See Also: type

valueErrorFor

protected String valueErrorFor(Object value)

Parameters: value Object

Returns: String

valueFrom

public Object valueFrom(String valueString)
Method valueFrom.

Parameters: valueString String

Returns: Object

See Also: valueFrom