revxrsal.commands.annotation

Annotation Type Switch

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

Marks a (strictly) boolean parameter as a "switch", whose value will be set by "flags", such as "--silent", which will represent a boolean parameter annotated with @Switch("silent").

Switches can have a long form and a short form. The long form is prefixed by --, while the short one is prefixed by -, i.e. --silent and -s.

Switches may have their short form combined in a Unix-like style: --silent --permanent can be -s -p and -sp.

Optional Element Summary

Optional Elements

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

Element Detail

value

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

The long form of the switch. If left empty, the parameter name will be used.

Returns:

The switch name

Default:

""

shorthand

public abstract char shorthand

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

Returns:

The switch's long form

Default:

0