Package org.kohsuke.args4j

Class OptionDef

java.lang.Object

org.kohsuke.args4j.OptionDef

Direct Known Subclasses:

NamedOptionDef

public class OptionDef
extends java.lang.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 java.lang.Class<? extends OptionHandler>	handler
private boolean	help
private boolean	hidden
private java.lang.String	metaVar
private boolean	multiValued
private boolean	required
private java.lang.String	usage

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

usage

private final java.lang.String usage

metaVar

private final java.lang.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 java.lang.Class<? extends OptionHandler> handler

Constructor Detail

OptionDef

public OptionDef(Argument a,
                 boolean forceMultiValued)

OptionDef

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

Method Detail

usage

public java.lang.String usage()

metaVar

public java.lang.String metaVar()

required

public boolean required()

help

public boolean help()

hidden

public boolean hidden()

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

handler

public java.lang.Class<? extends OptionHandler> handler()

isMultiValued

public boolean isMultiValued()

isArgument

public boolean isArgument()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object