Annotation Interface Option

public @interface Option
Describes a configuration option of a source generator.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    key
    Returns the key used to configure this option.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Returns a description of this configuration option.
    String
    sampleValue
    Returns a sample value for this option, if any.

  • Element Details

    • key

      String key
      Returns the key used to configure this option.
      Returns:
      the key, as found in properties

    • description

      String description
      Returns a description of this configuration option.
      Returns:
      the description
      Default:
      ""

    • sampleValue

      String sampleValue
      Returns a sample value for this option, if any.
      Returns:
      a sample value
      Default:
      ""