Package cloud.commandframework.annotations

Annotation Type Flag

  • @Target(PARAMETER)
@Retention(RUNTIME)
public @interface Flag
    Indicates that the parameter should be treated like a CommandFlag. If the parameter is a boolean then a presence flag will be created, else a value flag will be created and the parser will be resolved the same way as it would for a Argument

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String value
      The flag name

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String[] aliases
      Flag aliases
      java.lang.String description
      The argument description
      java.lang.String parserName
      Name of the parser.

    • Element Detail

      • value

        java.lang.String value
        The flag name
        Returns:
        Flag name

      • aliases

        java.lang.String[] aliases
        Flag aliases
        Returns:
        Aliases
        Default:
        {""}

      • parserName

        java.lang.String parserName
        Name of the parser. Leave empty to use the default parser for the parameter type
        Returns:
        Parser name
        Default:
        ""

      • description

        java.lang.String description
        The argument description
        Returns:
        Argument description
        Default:
        ""