org.googlecode.java_cl_parser
Annotation Type CLIOption

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface CLIOption

Required Element Summary

java.lang.String

name

Optional Element Summary

java.lang.String	defaultValue Default is CLIOption.NULL_STRING_VALUE which means no default.
java.lang.String	description
java.lang.String[]	enumeratedValues Defines a list of values that represent the valid argument values.
java.lang.String	longName Default is CLIOption.NULL_STRING_VALUE, which means no long name.
boolean	required Default is false
int	valueCardinality Default is 1.
java.lang.String	valueSeparator Defines char used to separate list entries in a value list.
CLIOption.value_type	valueType default is value_type.optional

Element Detail

name

public abstract java.lang.String name

longName

public abstract java.lang.String longName

Default is CLIOption.NULL_STRING_VALUE, which means no long name.

Returns:

Default:

"\u0000"

description

public abstract java.lang.String description

Default:

"No description provided"

required

public abstract boolean required

Default is false

Returns:

Default:

false

valueType

public abstract CLIOption.value_type valueType

default is value_type.optional

Returns:

Default:

org.googlecode.java_cl_parser.CLIOption.value_type.optional

valueCardinality

public abstract int valueCardinality

Default is 1. 0 means any, any specific number means that exact number of arguments

Returns:

Default:

1

valueSeparator

public abstract java.lang.String valueSeparator

Defines char used to separate list entries in a value list. Default is a comma.

Returns:

Default:

","

defaultValue

public abstract java.lang.String defaultValue

Default is CLIOption.NULL_STRING_VALUE which means no default.

Returns:

Default:

"\u0000"

enumeratedValues

public abstract java.lang.String[] enumeratedValues

Defines a list of values that represent the valid argument values. CLIOption.NULL_STRING_VALUE represents no enumerated values.

Returns:

Default:

{}