Module io.helidon.builder.api
Package io.helidon.builder.api

Annotation Interface Option.TraverseConfig

Enclosing class:
Option
@Target(METHOD) @Retention(CLASS) public static @interface Option.TraverseConfig
Definition of how Map keys and values should be constructed.

If this annotation is not used, traversed is automatically applied on String and primitive/boxed types. In all other cases, non-traverse approach is applied.

If this annotation is used, it will use the io.helidon.common.config.Config#traverse method to perform a depth-first traversal of the node and its subtrees. Note: this annotation takes effect only when used in combination with Option.Configured.

For example: 


 test-map:
    key: "test-value1"
    test-key:
       second-part: "test-value2"
       third-part: "test-value3"

Will be handled as: 


 key: "key" value: "test-value1"
 key: "test-key.second-part" value: "test-value2"
 key: "test-key.third-part" value: "test-value3"

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    value
    Whether to use traverse method to handle map key and value.

  • Element Details

    • value

      boolean value
      Whether to use traverse method to handle map key and value.
      Returns:
      true to enable traverse and false to disable
      Default:
      true