revxrsal.commands.annotation

Annotation Type Flag

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

An annotation to mark a parameter as a flag.

Flags are similar to normal parameters, however they do not need to come in a specific order, and are explicitly named with a special prefix when the command is invoked.

For example, /test (parameters) --name "hello there", in which name would be a flag parameter.

Flags can have a long form and a short form. The long form is prefixed by --, while the short one is prefixed by -.

Flags are compatible with Default and Optional, as in, they can be marked as optional or can have a default value when not specified.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
char	shorthand Returns the short form of the flag name.
@NotNull java.lang.String	value Returns the long form of the flag name.

Element Detail

value

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

Returns the long form of the flag name. If left empty, it will use the parameter name.

Returns:

The flag's long form

Default:

""

shorthand

public abstract char shorthand

Returns the short form of the flag name. If not explicitly specified, it will be the parameter's first character.

Returns:

The flag's long form

Default:

0