Package oracle.dbtools.plugin.api.cmdline.annotations

Annotation Type Option

  • @Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
@Documented
public @interface Option
    Describes an optional argument to a command.
    Author:
    cdivilly

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      TranslatableText description
      Description of the optional argument's purpose
      java.lang.String name
      The name of the option

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean hasArgument
      Indicates if the option takes a value
      java.lang.Class<?> type
      The type of the option value

    • Element Detail

      • name

        java.lang.String name
        The name of the option
        Returns:
        option name

      • description

        TranslatableText description
        Description of the optional argument's purpose
        Returns:
        option description

      • type

        java.lang.Class<?> type
        The type of the option value
        Returns:
        option type
        Default:
        java.lang.String.class

      • hasArgument

        boolean hasArgument
        Indicates if the option takes a value
        Returns:
        true if the option takes a value, false otherwise
        Default:
        true