org.apache.tools.ant.types
public abstract class EnumeratedAttribute extends Object
See {@link org.apache.tools.ant.taskdefs.FixCRLF FixCRLF} for an example.
Field Summary | |
---|---|
protected String | value
The selected value in this enumeration. |
Constructor Summary | |
---|---|
protected | EnumeratedAttribute() bean constructor |
Method Summary | |
---|---|
boolean | containsValue(String value)
Is this value included in the enumeration? |
int | getIndex() |
static EnumeratedAttribute | getInstance(Class clazz, String value)
Factory method for instantiating EAs via API in a more
developer friendly way. |
String | getValue() |
abstract String[] | getValues()
This is the only method a subclass needs to implement.
|
int | indexOfValue(String value)
get the index of a value in this enumeration. |
void | setValue(String value)
Invoked by {@link org.apache.tools.ant.IntrospectionHelper IntrospectionHelper}. |
String | toString()
Convert the value to its string form.
|
Parameters: value the String
value to look up
Returns: true if the value is valid
Returns: the index of the selected value in the array.
See Also: getValues
Parameters: clazz Class, extending EA, which to instantiate value The value to set on that EA
Returns: Configured EA
Throws: BuildException If the class could not be found or the value is not valid for the given EA-class.
See Also:
http://issues.apache.org/bugzilla/show_bug.cgi?id=14831
Returns: the selected value.
Returns: an array holding all possible values of the enumeration. The order of elements must be fixed so that indexOfValue(String) always return the same index for the same value.
Parameters: value the string value to look for.
Returns: the index of the value in the array of strings or -1 if it cannot be found.
See Also: getValues
Parameters: value the String
value of the attribute
Throws: BuildException if the value is not valid for the attribute
Returns: the string form of the value.