org.googlecode.java_cl_parser
Annotation Type CLIEntry

@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface CLIEntry

Required Element Summary

java.lang.String	description The description of this tool.
java.lang.String	version The current version number.

Optional Element Summary

java.lang.String	contact Identifier for the maintainer of this tool.
java.lang.String	documentationUrl Where this project documentation lives.
CLIOptionSet[]	invalidarameterSets A list of option sets which are invalid for this command.
java.lang.String	nickName The short name for this tool.
CLIEntry.parser_type	parserType This determines the exact syntax that is applied to the command line.
CLIOptionSet[]	validarameterSets A list of option sets which are valid for this command.
java.lang.String	versionControl Identifier for where this project lives in version control.

Element Detail

description

public abstract java.lang.String description

The description of this tool. This should provide enough information that a user will know how to use the tool without having to run through trial and error.

Returns:

version

public abstract java.lang.String version

The current version number. Required.

Returns:

nickName

public abstract java.lang.String nickName

The short name for this tool. This is only used in the generated documentation. The default is the simple class name as returned by Class.getSimpleName().

Returns:

Default:

"\u0000"

parserType

public abstract CLIEntry.parser_type parserType

This determines the exact syntax that is applied to the command line. These parser types match the Apache Commons CLI parsers.

Returns:

Default:

org.googlecode.java_cl_parser.CLIEntry.parser_type.gnu

contact

public abstract java.lang.String contact

Identifier for the maintainer of this tool. Could be an email address, messenger name, whatever.

Returns:

Default:

"\u0000"

documentationUrl

public abstract java.lang.String documentationUrl

Where this project documentation lives.

Returns:

Default:

"\u0000"

versionControl

public abstract java.lang.String versionControl

Identifier for where this project lives in version control. There are no rules, it just needs to be clear. E.G., for subversion ideally this would be a fully-qualified subversion URL.

Returns:

Default:

"\u0000"

validarameterSets

public abstract CLIOptionSet[] validarameterSets

A list of option sets which are valid for this command. If specified, the options specified must match one of these sets according to the set type or be considered invalid. If not specified, any option combinations are considered valid. This can be used in combination with invalidarameterSets as long as none of the sets overlap.

Returns:

Default:

{}

invalidarameterSets

public abstract CLIOptionSet[] invalidarameterSets

A list of option sets which are invalid for this command. If specified, any combination of options which match one of these sets according to the set type will be considered invalid. This can be used in combination with validarameterSets as long as none of the sets overlap.

Returns:

Default:

{}