Option (Groovy 5.0.6)

Package: groovy.cli

## [Java] Annotation Type Option

- groovy.cli.Option

-     @Documented
      @Retention(RetentionPolicy.RUNTIME)
      @Target({ElementType.METHOD, ElementType.FIELD})
      public @interface Option

  Indicates that a method or property can be used to set a CLI option.

- - ### Element Summary

    Optional Element Summary
    Type | Name and Description
    --- | ---
    `Class` | `convert` A conversion closure to convert the incoming String into the desired object
    `String` | `defaultValue` The default value for this option as a String; subject to type conversion and 'convert'.
    `String` | `description` The description of this option
    `String` | `longName` The long name of this option.
    `int` | `numberOfArguments` How many arguments this option has.
    `String` | `numberOfArgumentsString` How many arguments this option has represented as a String.
    `boolean` | `optionalArg` Whether this option can have an optional argument.
    `String` | `shortName` The short name of this option.
    `String` | `valueSeparator` The value separator for this multivalued option.

  - ### Inherited Methods Summary

    Inherited Methods
    Methods inherited from class | Name
    --- | ---
    `class Object` | `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Element Detail

    - #### public Class convert

      A conversion closure to convert the incoming String into the desired object

      Returns:
        the closure to convert this option's argument(s)
      Default:
        Undefined.CLASS.class

    - #### public String defaultValue

      The default value for this option as a String; subject to type conversion and 'convert'. Ignored for Boolean options.

      Returns:
        the default value for this option
      Default:
        ""

    - #### public String description

      The description of this option

      Returns:
        the description of this option
      Default:
        ""

    - #### public String longName

      The long name of this option. Defaults to the name of member being annotated.

      Returns:
        the long name of this option
      Default:
        ""

    - #### public int numberOfArguments

      How many arguments this option has. A value greater than 1 is only allowed for array-typed arguments. Ignored for boolean options which are assumed to have a default of 0 or if `numberOfArgumentsString` is set.

      Returns:
        the number of arguments
      Default:
        1

    - #### public String numberOfArgumentsString

      How many arguments this option has represented as a String. Only allowed for array-typed arguments. Overrides `numberOfArguments` if set. The special values of '+' means one or more and '*' as 0 or more.

      Returns:
        the number of arguments (as a String)
      Default:
        ""

    - #### public boolean optionalArg

      Whether this option can have an optional argument. Only supported for array-typed arguments to indicate that the array may be empty.

      Returns:
        true if this array-typed option can have an optional argument (i.e. could be empty)
      Default:
        false

    - #### public String shortName

      The short name of this option. Defaults to the name of member being annotated if the longName is empty.

      Returns:
        the short name of this option
      Default:
        ""

    - #### public String valueSeparator

      The value separator for this multivalued option. Only allowed for array-typed arguments.

      Returns:
        the value separator for this multivalued option
      Default:
        ""