args4j 2.0.12-redhat-1

org.kohsuke.args4j
Enum ExampleMode

java.lang.Object
  extended by java.lang.Enum<ExampleMode>
      extended by org.kohsuke.args4j.ExampleMode
All Implemented Interfaces:
Serializable, Comparable<ExampleMode>

public enum ExampleMode
extends Enum<ExampleMode>

Used with CmdLineParser.printExample(ExampleMode).

Author:
Kohsuke Kawaguchi

Enum Constant Summary
ALL
          Print all defined options in the example.
REQUIRED
          Print all required option.
 
Method Summary
static ExampleMode valueOf(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.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

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 all required 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(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 name
NullPointerException - if the argument is null

args4j 2.0.12-redhat-1

Copyright © 2003-2012 JBoss by Red Hat. All Rights Reserved.