Annotation Type Argument

@Retention(RUNTIME) @Target({FIELD,METHOD,PARAMETER}) public @interface Argument
Argument of the command line. This works mostly like Option except the following differences.
  1. Arguments have an index about their relative position on the command line.
Author:
Kohsuke Kawaguchi, Mark Sinke

  • Element Details

    • usage

      String usage
      See Option.usage().
      Default:
      ""

    • metaVar

      String metaVar
      See Option.metaVar().
      Default:
      ""

    • required

      boolean required
      See Option.required().
      Default:
      false

    • hidden

      boolean hidden
      See Option.hidden().
      Default:
      false

    • handler

      Class<? extends OptionHandler> handler
      See Option.handler().
      Default:
      org.kohsuke.args4j.spi.OptionHandler.class

    • index

      int index
      Position of the argument.

      If you define multiple single value properties to bind to arguments, they should have index=0, index=1, index=2, ... and so on.

      Multi value properties bound to arguments must be always the last entry.

      Default:
      0

    • multiValued

      boolean multiValued
      Default:
      false