Package org.kohsuke.args4j

Class OptionDef

java.lang.Object

org.kohsuke.args4j.OptionDef

Direct Known Subclasses:

NamedOptionDef

public class OptionDef
extends Object

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.

Field Summary

Fields

Modifier and Type	Field	Description
private final Class<? extends OptionHandler>	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

Constructors

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

Method Summary

Modifier and Type	Method	Description
Class<? extends OptionHandler>	handler()
boolean	help()
boolean	hidden()	Value from Option.hidden() or Argument.hidden()
boolean	isArgument()
boolean	isMultiValued()
String	metaVar()
boolean	required()
String	toString()
String	usage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

usage

private final String usage

metaVar

private final String metaVar

required

private final boolean required

help

private final boolean help

hidden

private final boolean hidden

multiValued

private final boolean multiValued

handler

private final Class<? extends OptionHandler> handler

Constructor Details

OptionDef

public OptionDef(Argument a,
 boolean forceMultiValued)

OptionDef

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

Method Details

usage

public String usage()

metaVar

public String metaVar()

required

public boolean required()

help

public boolean help()

hidden

public boolean hidden()

Value from Option.hidden() or Argument.hidden()

handler

public Class<? extends OptionHandler> handler()

isMultiValued

public boolean isMultiValued()

isArgument

public boolean isArgument()

toString

public String toString()

Overrides:

toString in class Object