Package adams.core.option.help
Enum HelpFormat
- java.lang.Object
-
- java.lang.Enum<HelpFormat>
-
- adams.core.option.help.HelpFormat
-
- All Implemented Interfaces:
Serializable
,Comparable<HelpFormat>
public enum HelpFormat extends Enum<HelpFormat>
The type of help to generate.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description HTML
PLAIN_TEXT
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static HelpFormat
valueOf(String name)
Returns the enum constant of this type with the specified name.static HelpFormat[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
PLAIN_TEXT
public static final HelpFormat PLAIN_TEXT
-
HTML
public static final HelpFormat HTML
-
-
Method Detail
-
values
public static HelpFormat[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (HelpFormat c : HelpFormat.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static HelpFormat valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-