Top Description Fields Constructors Methods
org.kohsuke.args4j

public sealed Enum ExampleMode

extends Enum<ExampleMode>
implements OptionHandlerFilter
Class Inheritance
All Implemented Interfaces
org.kohsuke.args4j.OptionHandlerFilter
Imports
org.kohsuke.args4j.spi.OptionHandler

Deprecated

use OptionHandlerFilter

Used with CmdLineParser#printExample(ExampleMode).
Author
Kohsuke Kawaguchi

Field Summary

Modifier and TypeField and Description
public static final ExampleMode
ALL

Hides org.kohsuke.args4j.OptionHandlerFilter.ALL.

References Deprecated ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.
Print all defined options in the example.
public static final ExampleMode
REQUIRED

Hides org.kohsuke.args4j.OptionHandlerFilter.REQUIRED.

References Deprecated ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.
Print all required option.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ExampleMode
valueOf(String name)
References Deprecated ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.

public static ExampleMode[]
values()
References Deprecated ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ALLback to summary
public static final ExampleMode ALL

Hides org.kohsuke.args4j.OptionHandlerFilter.ALL.

References Deprecated

ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Print all defined options in the example.

This would only be useful with small numbers of options.

REQUIREDback to summary
public static final ExampleMode REQUIRED

Hides org.kohsuke.args4j.OptionHandlerFilter.REQUIRED.

References Deprecated

ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Print all required option.

Constructor Detail

ExampleModeback to summary
private ExampleMode()

Method Detail

valueOfback to summary
public static ExampleMode valueOf(String name)

References Deprecated

ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

valuesback to summary
public static ExampleMode[] values()

References Deprecated

ExampleMode is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.