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, a presence flag will be created
    • If the parameter is of any other type, a value flag will be created and the parser will resolve it in the same way that it would for an Argument

    • Required Element Summary

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

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      @NonNull java.lang.String[] aliases
      Flag aliases
      @NonNull java.lang.String description
      The argument description
      @NonNull java.lang.String parserName
      Name of the parser.
      @NonNull java.lang.String suggestions
      Name of the suggestions provider to use.

    • Element Detail

      • value

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

      • aliases

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

      • parserName

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

      • suggestions

        @NonNull java.lang.String suggestions
        Name of the suggestions provider to use. If the string is left empty, the default provider for the argument parser will be used. Otherwise, the ParserRegistry instance in the CommandManager will be queried for a matching suggestion provider.

        For this to work, the suggestion needs to be registered in the parser registry. To do this, use ParserRegistry.registerSuggestionProvider(String, BiFunction). The registry instance can be retrieved using CommandManager.getParserRegistry().

        Returns:
        The name of the suggestion provider, or "" if the default suggestion provider for the argument parser should be used instead
        Since:
        1.2.0
        Default:
        ""

      • description

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