Annotation Interface Option.Configured

Enclosing class:
Option
@Target(METHOD) @Inherited @Retention(CLASS) public static @interface Option.Configured
Mark a prototype option as one that can be read from io.helidon.config.Config.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    merge
    If set to true, the nested configurable object will not have its own config key, but will use the config of the current configurable object.
    boolean
    metadata
    Whether to include this option in generated configuration metadata.
    String
    value
    Override "guessed" configuration key.

  • Element Details

    • value

      String value
      Override "guessed" configuration key. The configuration key is the method name converted to snake case by default.
      Returns:
      custom configuration key
      Default:
      ""

    • merge

      boolean merge
      If set to true, the nested configurable object will not have its own config key, but will use the config of the current configurable object.
      Returns:
      whether to merge the nested object into this object
      Default:
      false

    • metadata

      boolean metadata
      Whether to include this option in generated configuration metadata. This setting does not affect configuration reading.
      Returns:
      whether to include this option in generated configuration metadata
      Default:
      true