org.sonatype.gshell.util.cli2
Class OptionDescriptor

java.lang.Object
  org.sonatype.gshell.util.AnnotationDescriptor
      org.sonatype.gshell.util.cli2.CliDescriptor
          org.sonatype.gshell.util.cli2.OptionDescriptor

public class OptionDescriptor
extends CliDescriptor

Option descriptor.

Since:

2.3

Author:

Jason Dillon

Field Summary

static int	UNINITIALIZED
static int	UNLIMITED

Fields inherited from class org.sonatype.gshell.util.AnnotationDescriptor

UNINITIALIZED_CHAR, UNINITIALIZED_CLASS, UNINITIALIZED_STRING

Constructor Summary

OptionDescriptor(Option spec, Setter setter)

Method Summary

int	getArgs()
String	getLongName()
String	getName()
boolean	getOverride()
char	getSeparator()
Option	getSpec()
String	getSyntax()
boolean	isArgumentOptional()

Methods inherited from class org.sonatype.gshell.util.cli2.CliDescriptor

getDescription, getHandler, getHandlerType, getId, getMessageCode, getSetter, getToken, getTokenCode, getType, isArgument, isMultiValued, isOption, isRequired, renderHelpText, renderSyntax, renderToken

Methods inherited from class org.sonatype.gshell.util.AnnotationDescriptor

toString

Methods inherited from class java.lang.Object

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

Field Detail

UNINITIALIZED

public static final int UNINITIALIZED

See Also:

Constant Field Values

UNLIMITED

public static final int UNLIMITED

See Also:

Constant Field Values

Constructor Detail

OptionDescriptor

public OptionDescriptor(Option spec,
                        Setter setter)

Method Detail

getSpec

public Option getSpec()

getName

public String getName()

getLongName

public String getLongName()

getSeparator

public char getSeparator()

getArgs

public int getArgs()

isArgumentOptional

public boolean isArgumentOptional()

getOverride

public boolean getOverride()

getSyntax

public String getSyntax()

Specified by:

getSyntax in class CliDescriptor