Package cloud.commandframework.annotations

Annotation Type Argument

  • @Retention(RUNTIME)
@Target(PARAMETER)
public @interface Argument
    Annotation used to indicate that a method parameter is a command argument

    • Required Element Summary

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

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String defaultValue
      Get the default value
      java.lang.String description
      The argument description
      java.lang.String parserName
      Name of the argument parser

    • Element Detail

      • value

        java.lang.String value
        Argument name
        Returns:
        Argument name

      • parserName

        java.lang.String parserName
        Name of the argument parser
        Returns:
        Argument name
        Default:
        ""

      • defaultValue

        java.lang.String defaultValue
        Get the default value
        Returns:
        Default value
        Default:
        ""

      • description

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