Annotation Interface NamedConfigValue


@Target(FIELD) @Retention(RUNTIME) @Documented public @interface NamedConfigValue
This annotation denotes configuration schema fields that are dynamically created and mapped by name. Example use-cases for this annotation are Ignite node configuration, cache configuration, because nodes and caches can be added dynamically. Every field annotated with this annotation will produce a NamedListConfiguration field in generated configuration class.

 @Config(value = "local", root = true)
 public class LocalConfigurationSchema {

      @NamedConfigValue
      private SomeOtherConfiguration someOther;

 }
 
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Key that can be used in HOCON configuration syntax to declare named list with fixed order.
  • Element Details

    • syntheticKeyName

      String syntheticKeyName
      Key that can be used in HOCON configuration syntax to declare named list with fixed order.
      
       {
           root : {
               namedList : [
                   {
                       syntheticKey : Element1,
                       someValue = Value1
                   },
                   {
                       syntheticKey : Element2,
                       someValue = Value2
                   }
               ]
           }
       }
       
      Returns:
      Name for the synthetic key.
      Default:
      "name"