Package io.quarkus.runtime.annotations

Annotation Type 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
      Determine the base key of the configuration root.
      ConfigPhase phase
      Determine the phase of this configuration root.
      String prefix
      Determine the prefix key of the configuration root.

    • Element Detail

      • prefix

        String prefix
        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:
        io.quarkus.runtime.annotations.ConfigPhase.BUILD_TIME

      • name

        String name
        Determine the base key of the configuration root.
        Returns:
        the base key name
        Default:
        "<<hyphenated element name>>"