Package io.quarkus.runtime.annotations

Annotation Interface ConfigRoot

@Retention(RUNTIME) @Target(TYPE) @Documented public @interface ConfigRoot
Indicate that the given item is a configuration root. Instances of classes with this annotation will be made available to build steps or run time recorders, according to the phase of the value.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use interface-based @ConfigMapping instead.
    ConfigPhase
    phase
    Determine the phase of this configuration root.
    String
    prefix
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use interface-based @ConfigMapping instead.

  • Element Details

    • prefix

      @Deprecated(since="3.19", forRemoval=true) String prefix
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use interface-based @ConfigMapping instead. When moving to @ConfigMapping, the prefix has to be included in the @ConfigMapping#prefix together with the name.
      Determine the prefix key of the configuration root.
      Returns:
      the prefix key name
      Default:
      "quarkus"

    • phase

      ConfigPhase phase
      Determine the phase of this configuration root.
      Returns:
      the phase
      Default:
      BUILD_TIME

    • name

      @Deprecated(since="3.19", forRemoval=true) String name
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use interface-based @ConfigMapping instead. Be careful, @ConfigRoot(name = "extension") may be migrated to @ConfigMapping(prefix = "quarkus.extension"). If no name was defined, make sure to define a prefix in @ConfigMapping as it's mandatory.
      Determine the base key of the configuration root.
      Returns:
      the base key name
      Default:
      "<<hyphenated element name>>"