org.kaiwitte.joptions
Interface Option

public interface Option

An Option chosen by the user of the program. In the XML declaration file it is defined using the <Option>-tag.

Method Summary

java.lang.String[]	getChoices() Returns default values.
boolean	getFreeChoice() Returns true iff the user can enter arbitrary values for this option rather than only what is returned by getChoices().
java.lang.Class	getType() Returns a Class indicating the type of the option.
java.lang.String	getValue() Returns the String representation of the option.

Method Detail

getValue

java.lang.String getValue()

Returns the String representation of the option.

Returns:

the String representation of the option.

getType

java.lang.Class getType()

Returns a Class indicating the type of the option. Typically, this method is not used by clients of this library. Maybe it will be removed in the beta version.

Returns:

the type

getChoices

java.lang.String[] getChoices()

Returns default values. These values are typically displayed in a combo box. (For the future.)

Returns:

default values

getFreeChoice

boolean getFreeChoice()

Returns true iff the user can enter arbitrary values for this option rather than only what is returned by getChoices().

Returns:

wether the user can enter arbitrary values