net.sf.mmm.util.cli.api

Annotation Type CliClass

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface CliClass

A CliClass is used to annotate a Java-class that holds the parameters of a main-program that are parsed from the commandline arguments.
It declares the name of the program and the additional usage information. This annotation is optional, however it is recommended to declare it for the reason of documentation and maintenance. If it is not present, the defaults will apply.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

CliStyle, CliOption, CliArgument, AbstractMain

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name The name of the main-program for the usage.
String	usage A brief description of what this program actually does.

Element Detail

name

public abstract String name

The name of the main-program for the usage. By default the qualified classname of the program is used. You can set this explicitly if your main-program is always run from a front-end shell-script or you do NOT want to annotate you main-program class but use an externalized state object.

Default:

""

usage

public abstract String usage

A brief description of what this program actually does. This is added to the generated usage help of the program. If not set no additional custom description will be printed.

Default:

""