me.vaperion.blade.annotation.parameter

Annotation Type Flag

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface Flag

This annotation is used to create a flag.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
char	value The character value of the flag that can be used as -f.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
@NotNull java.lang.String	description The description of the flag.
@NotNull java.lang.String	longName The long flag name that can be used as --longName.
boolean	required Whether the flag is required or not.

Element Detail

value

public abstract char value

The character value of the flag that can be used as -f.

Returns:

the flag character

longName

@NotNull
public abstract @NotNull java.lang.String longName

The long flag name that can be used as --longName.

Returns:

the long flag name

Default:

""

description

@NotNull
public abstract @NotNull java.lang.String description

The description of the flag.

Returns:

the flag description

Default:

""

required

public abstract boolean required

Whether the flag is required or not.

Returns:

true if the flag is required, false otherwise

Default:

false