Annotation Interface Option

@Retention(RUNTIME) @Target(PARAMETER) public @interface Option
Declares a parameter as a named option (e.g. --amount, -a). Options can be used alongside positional arguments.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    flag
    Marks this option as a flag (no value required).
    String[]
    longNames
    Long option names without "--" prefix.
    String[]
    shortNames
    Short option names without "-" prefix.

  • Element Details

    • shortNames

      String[] shortNames
      Short option names without "-" prefix.
      Returns:
      short option names
      Default:
      {}

    • longNames

      String[] longNames
      Long option names without "--" prefix.
      Returns:
      long option names
      Default:
      {}

    • flag

      boolean flag
      Marks this option as a flag (no value required).
      Returns:
      true when this is a flag
      Default:
      false