org.cyclopsgroup.jcli.annotation
Annotation Type Cli

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

Type annotated with Cli is considered as a command where options and arguments are set

Author:

Jiaqi Guo

Required Element Summary

String

name

Optional Element Summary

String	description
String	note
boolean	restrict

Element Detail

name

public abstract String name

Returns:

Name of command

description

public abstract String description

Returns:

String description of command

Default:

""

note

public abstract String note

Returns:

Note displayed as footer

Default:

""

restrict

public abstract boolean restrict

Returns:

True if unexpected option or argument is expected to cause error

Default:

true