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

Annotation Interface Prototype.Configured

Enclosing class:
Prototype
@Target(TYPE) @Retention(CLASS) public static @interface Prototype.Configured
A blueprint annotated with this annotation will create a prototype that can be created from a Config instance. The builder will also have a method config(Config) that reads all options annotated with Option.Configured from the config.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    root
    If value() is specified, it is considered to be a root configuration node.
    String
    value
    Configuration node this type is read from.

  • Element Details

    • value

      String value
      Configuration node this type is read from. This implies a root configuration node by default, can be overridden using root().
      Returns:
      configuration key of this type, from the root of configuration
      Default:
      ""

    • root

      boolean root
      If value() is specified, it is considered to be a root configuration node. Set this property to false to explicitly mark this configuration as non-root. This is useful for services that provide an implementation of a provider.
      Returns:
      whether this is a root node, ignored if value() is an empty string
      Default:
      true