Top Description Fields Constructors Methods

org.kohsuke.args4j

public Class OptionDef

Class Inheritance

extends Object

java.lang.Object
org.kohsuke.args4j.OptionDef

Known Direct Subclasses

org.kohsuke.args4j.NamedOptionDef

Imports

org.kohsuke.args4j.spi.OptionHandler

Run-time copy of the Option or Argument annotation. By definition, unnamed options are arguments (and instances of this class). Named options are actually a subclass.

Author: Mark Sinke

Field Summary

Modifier and Type	Field and Description
private final Class<? extends OptionHandler<T>>	handler
private final boolean	help
private final boolean	hidden
private final String	metaVar
private final boolean	multiValued
private final boolean	required
private final String	usage

Constructor Summary

Access	Constructor and Description
public	OptionDef(Argument a, boolean forceMultiValued)
protected	OptionDef(String usage, String metaVar, boolean required, boolean help, boolean hidden, Class<? extends OptionHandler<T>> handler, boolean multiValued)

Method Summary

Modifier and Type	Method and Description
public Class<? extends OptionHandler<T>>	handler()
public boolean	help()
public boolean	hidden() Value from `Option#hidden()` or `Argument#hidden()`
public boolean	isArgument()
public boolean	isMultiValued()
public String	metaVar()
public boolean	required()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	usage()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

handler	back to summary
private final Class<? extends OptionHandler<T>> handler

help	back to summary
private final boolean help

hidden	back to summary
private final boolean hidden

metaVar	back to summary
private final String metaVar

multiValued	back to summary
private final boolean multiValued

required	back to summary
private final boolean required

usage	back to summary
private final String usage

Constructor Detail

OptionDef	back to summary
public OptionDef(Argument a, boolean forceMultiValued)

OptionDef	back to summary
protected OptionDef(String usage, String metaVar, boolean required, boolean help, boolean hidden, Class<? extends OptionHandler<T>> handler, boolean multiValued)

Method Detail

handler	back to summary
public Class<? extends OptionHandler<T>> handler()

help	back to summary
public boolean help()

hidden	back to summary
public boolean hidden() Value from `Option#hidden()` or `Argument#hidden()`

isArgument	back to summary
public boolean isArgument()

isMultiValued	back to summary
public boolean isMultiValued()

metaVar	back to summary
public String metaVar()

required	back to summary
public boolean required()

toString back to summary

public String toString()

Overrides java.lang.Object.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

usage	back to summary
public String usage()