Package hudson.cli.declarative

Annotation Type CLIMethod

  • @Indexed
@Retention(RUNTIME)
@Target(METHOD)
@Documented
public @interface CLIMethod
    Annotates methods on model objects to expose them as CLI commands.

    You need to have Messages.properties in the same package with the CLI.<i>command-name</i>.shortDescription key to describe the command. This is used for the same purpose as CLICommand.getShortDescription().

    If you put a CLIMethod on an instance method (as opposed to a static method), you need a corresponding CLI resolver method.

    A CLI method can have its parameters annotated with ListBoxModel.Option and Argument, to receive parameter/argument injections.

    A CLI method needs to be public.

    Since:
    1.321
    Author:
    Kohsuke Kawaguchi
    See Also:
    CLICommand

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      String name
      CLI command name.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean usesChannel