Top Description Fields Constructors Methods
org.kohsuke.args4j

public final Class NamedOptionDef

extends OptionDef
Class Inheritance
Imports
java.util.Arrays
Immutable run-time copy of Option annotation.

Field Summary

Modifier and TypeField and Description
private final String[]
aliases

private final String[]
depends

private final String[]
forbids

private final String
name

Constructor Summary

AccessConstructor and Description
public
NamedOptionDef(Option o, boolean forceMultiValued)
Deprecated multi-valuedness as option definition does not make sense. It's driven by the setter.

public
NamedOptionDef(Option o)

Method Summary

Modifier and TypeMethod and Description
public String[]
aliases()

private static String[]
createZeroSizedArrayIfNull(String[] in)

public String[]
depends()

public String[]
forbids()

public boolean
isArgument()

Overrides org.kohsuke.args4j.OptionDef.isArgument.

public String
name()

public String
toString()

Overrides org.kohsuke.args4j.OptionDef.toString.

Returns a string representation of the object.

Inherited from org.kohsuke.args4j.OptionDef:
handlerhelphiddenisMultiValuedmetaVarrequiredusage

Field Detail

aliasesback to summary
private final String[] aliases
dependsback to summary
private final String[] depends
forbidsback to summary
private final String[] forbids
nameback to summary
private final String name

Constructor Detail

NamedOptionDefback to summary
public NamedOptionDef(Option o, boolean forceMultiValued)

Deprecated

multi-valuedness as option definition does not make sense. It's driven by the setter.

NamedOptionDefback to summary
public NamedOptionDef(Option o)

Method Detail

aliasesback to summary
public String[] aliases()
createZeroSizedArrayIfNullback to summary
private static String[] createZeroSizedArrayIfNull(String[] in)
dependsback to summary
public String[] depends()
forbidsback to summary
public String[] forbids()
isArgumentback to summary
public boolean isArgument()

Overrides org.kohsuke.args4j.OptionDef.isArgument.

Annotations
@Override
nameback to summary
public String name()
toStringback to summary
public String toString()

Overrides org.kohsuke.args4j.OptionDef.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override