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>, OptionHandlerFilter

Deprecated.

use OptionHandlerFilter

public enum ExampleMode
extends java.lang.Enum<ExampleMode>
implements OptionHandlerFilter

Used with CmdLineParser.printExample(ExampleMode).

Author:

Kohsuke Kawaguchi

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Deprecated. Print all defined options in the example.
REQUIRED Deprecated. Print all required option.

Field Summary

Fields inherited from interface org.kohsuke.args4j.OptionHandlerFilter

ALL, PUBLIC, REQUIRED

Method Summary

Methods

Modifier and Type	Method and Description
static ExampleMode	valueOf(java.lang.String name) Deprecated. Returns the enum constant of this type with the specified name.
static ExampleMode[]	values() Deprecated. 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

Methods inherited from interface org.kohsuke.args4j.OptionHandlerFilter

select

Enum Constant Detail

ALL

public static final ExampleMode ALL

Deprecated.

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

Deprecated.

Print all required option.

Method Detail

values

public static ExampleMode[] values()

Deprecated.

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)

Deprecated.

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 name

java.lang.NullPointerException - if the argument is null