Apache Ant Core 1.10.14 · org.apache.tools.ant.types.EnumeratedAttribute

Modifier and Type	Field and Description
private int	index the index of the selected value in the array.
protected String	value The selected value in this enumeration.

Modifier and Type

Field and Description

private int

index

the index of the selected value in the array.

protected String

value

The selected value in this enumeration.

Access	Constructor and Description
protected	EnumeratedAttribute() bean constructor

Access

Constructor and Description

protected

EnumeratedAttribute()

bean constructor

Method Summary

Modifier and Type	Method and Description
public final boolean	Returns: true if the value is valid containsValue(String the `String` value to look up value) Is this value included in the enumeration?
public final int	Returns: the index of the selected value in the array. getIndex()
public static EnumeratedAttribute	Returns: Configured EA getInstance(Class<? extends EnumeratedAttribute> Class, extending EA, which to instantiate clazz, String The value to set on that EA value) Factory method for instantiating EAs via API in a more developer friendly way.
public final String	Returns: the selected value. getValue()
public abstract String[]	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. getValues() This is the only method a subclass needs to implement.
public final int	Returns: the index of the value in the array of strings or -1 if it cannot be found. indexOfValue(String the string value to look for. value) get the index of a value in this enumeration.
public void	setValue(String the `String` value of the attribute value) Invoked by `IntrospectionHelper`.
public String	Returns: the string form of the value. toString() Overrides java.lang.Object.toString. Convert the value to its string form.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

index	back to summary
private int index the index of the selected value in the array.

index

back to summary

private int index

the index of the selected value in the array.

value	back to summary
protected String value The selected value in this enumeration.

value

back to summary

protected String value

The selected value in this enumeration.

EnumeratedAttribute	back to summary
protected EnumeratedAttribute() bean constructor

EnumeratedAttribute

back to summary

protected EnumeratedAttribute()

bean constructor

Method Detail

containsValue back to summary

containsValue	back to summary
public final boolean containsValue(String value) Is this value included in the enumeration? Parameters value:String the `String` value to look up Returns:boolean true if the value is valid

public final boolean containsValue(String value)

Is this value included in the enumeration?

Parameters

value:String: the String value to look up

Returns:boolean

true if the value is valid

getIndex	back to summary
public final int getIndex() Returns:int the index of the selected value in the array. See Also `getValues()`

getInstance	back to summary
public static EnumeratedAttribute getInstance(Class<? extends EnumeratedAttribute> clazz, String value) throws BuildException Factory method for instantiating EAs via API in a more developer friendly way. Parameters clazz:Class<? extends EnumeratedAttribute> Class, extending EA, which to instantiate value:String The value to set on that EA Returns:EnumeratedAttribute Configured EA Exceptions BuildException: If the class could not be found or the value is not valid for the given EA-class. See Also https://issues.apache.org/bugzilla/show_bug.cgi?id=14831

getInstance

back to summary

public static EnumeratedAttribute getInstance(Class<? extends EnumeratedAttribute> clazz, String value) throws BuildException

Factory method for instantiating EAs via API in a more developer friendly way.

Parameters

clazz:Class<? extends EnumeratedAttribute>: Class, extending EA, which to instantiate
value:String: The value to set on that EA

Returns:EnumeratedAttribute

Configured EA

Exceptions

BuildException:: If the class could not be found or the value is not valid for the given EA-class.

getValue	back to summary
public final String getValue() Returns:String the selected value.

getValues back to summary

getValues	back to summary
public abstract String[] getValues() This is the only method a subclass needs to implement. Returns:String[] 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.

public abstract String[] getValues()

This is the only method a subclass needs to implement.

Returns:String[]: 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.

indexOfValue back to summary

indexOfValue	back to summary
public final int indexOfValue(String value) get the index of a value in this enumeration. Parameters value:String the string value to look for. Returns:int the index of the value in the array of strings or -1 if it cannot be found. See Also `getValues()`

public final int indexOfValue(String value)

get the index of a value in this enumeration.

Parameters

value:String: the string value to look for.

Returns:int

the index of the value in the array of strings or -1 if it cannot be found.

See Also

getValues()

setValue back to summary

setValue	back to summary
public void setValue(String value) throws BuildException Invoked by `IntrospectionHelper`. Parameters value:String the `String` value of the attribute Exceptions BuildException: if the value is not valid for the attribute

public void setValue(String value) throws BuildException

Invoked by IntrospectionHelper.

Parameters

value:String: the String value of the attribute

Exceptions

BuildException:: if the value is not valid for the attribute

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Convert the value to its string form. Returns:String the string form of the value. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Convert the value to its string form.

Returns:String

the string form of the value.

Annotations

@Override

public abstract Class EnumeratedAttribute

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail