Annotation Type BashCompletion


  • @Retention(RUNTIME)
    @Target(FIELD)
    public @interface BashCompletion
    Annotates a field with Bash completion information
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      CompletionBehaviour behaviour
      Sets the desired completion behaviour
      java.lang.String command
      Provides a command used to generate the completion words for this option
    • Element Detail

      • behaviour

        CompletionBehaviour behaviour
        Sets the desired completion behaviour

        This is used by usage generators that are capable of generating completion scripts. It indicates any additional completion behaviour that should apply in addition to command() or other behaviours obtained from the option/argument meta-data.

        Returns:
        Completion Behaviours
        Default:
        com.github.rvesse.airline.help.cli.bash.CompletionBehaviour.NONE
      • command

        java.lang.String command
        Provides a command used to generate the completion words for this option

        This is used by usage generators that are capable of generating completion scripts.

        Returns:
        Completion command
        Default:
        ""