shelly.commands

Annotation Type Option

public @interface Option

A way to define command line options/arguments for Command

Author:

jaroslaw.palka@symentis.pl

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	opt Identification string of the Option

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	arg a flag to say whether the option takes an argument
String	argName
int	args
String	description a description of the function of the option
String	longOpt an alias and more descriptive identification string
int	optionalArg
boolean	required a flag to say whether the option must appear on the command line.
Class<?>	type
char	valueSeparator

Element Detail

opt

public abstract String opt

Identification string of the Option

Returns:

longOpt

public abstract String longOpt

an alias and more descriptive identification string

Returns:

Default:

""

description

public abstract String description

a description of the function of the option

Returns:

Default:

""

required

public abstract boolean required

a flag to say whether the option must appear on the command line.

Returns:

Default:

false

arg

public abstract boolean arg

a flag to say whether the option takes an argument

Returns:

Default:

false

args

public abstract int args

Default:

0

optionalArg

public abstract int optionalArg

Default:

0

argName

public abstract String argName

Default:

""

valueSeparator

public abstract char valueSeparator

Default:

44

type

public abstract Class<?> type

Default:

java.lang.String.class