com.github.yin.cli.annotations

Annotation Type Usage

@Retention(value=RUNTIME)
 @Target(value={FIELD,TYPE})
public @interface Usage

Annotates class and fields with flag descriptions, seen in e.g. usage help. If supplied, name() is used to determine flag name, otherwise field name of the annotated field is used. For classpath-scanning to work correctly, each class having a @Usage member must be itself annotated with @Usage.

{@code

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Flag description.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name Name of flag.

Element Detail

value

public abstract String value

Flag description.

name

public abstract String name

Name of flag.

Default:

""