Package org.kohsuke.args4j
Enum ExampleMode
- java.lang.Object
-
- java.lang.Enum<ExampleMode>
-
- org.kohsuke.args4j.ExampleMode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ExampleMode>
public enum ExampleMode extends java.lang.Enum<ExampleMode>
Used withCmdLineParser.printExample(ExampleMode)
.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ExampleMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ExampleMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ALL
public static final ExampleMode ALL
Print all defined options in the example.This would be useful only when you have small number of options.
-
REQUIRED
public static final ExampleMode REQUIRED
Print allrequired
option.
-
-
Method Detail
-
values
public static ExampleMode[] 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 (ExampleMode c : ExampleMode.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ExampleMode valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-