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

Annotation Interface Prototype.ConfigFactoryMethod

Enclosing class:
Prototype
@Target(METHOD) @Retention(CLASS) public static @interface Prototype.ConfigFactoryMethod
Factory method that creates an option from a config instance. The config (the only parameter) must be of type io.helidon.config.Config.

The return type of the method must match the type of the option.

This annotation MUST be on a static method that is part of a type referenced from blueprint through Prototype.CustomMethods.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    An explicit option name can be defined to only use this factory method for the specified option.

  • Element Details

    • value

      String value
      An explicit option name can be defined to only use this factory method for the specified option. If none is specified, the factory method will be used for all options of the matching type.
      Returns:
      option name
      Default:
      ""