Package io.quarkus.deployment.builditem

Class ConfigPropertiesBuildItem

java.lang.Object
io.quarkus.builder.item.BuildItem
io.quarkus.builder.item.MultiBuildItem
io.quarkus.deployment.builditem.ConfigPropertiesBuildItem
public final class ConfigPropertiesBuildItem extends io.quarkus.builder.item.MultiBuildItem
A MultiBuildItem used to register a class annotated with @ConfigProperties for build-time configuration mapping in Quarkus.

This build item allows Quarkus to generate an implementation of the configuration class based on the provided prefix, enabling strong typing and reflection-free access to configuration properties.

Multiple instances of this build item can be produced, one for each configuration class.

See Also:
  • ConfigProperties

  • Constructor Details

    • ConfigPropertiesBuildItem

      public ConfigPropertiesBuildItem(Class<?> configClass, String prefix)
      Constructs a new ConfigPropertiesBuildItem.
      Parameters:
      configClass - the class annotated with @ConfigProperties. Must not be null.
      prefix - the configuration prefix associated with the class. Must not be null.

  • Method Details

    • getConfigClass

      public Class<?> getConfigClass()
      Returns the configuration class annotated with @ConfigProperties.
      Returns:
      the configuration class.

    • getPrefix

      public String getPrefix()
      Returns the configuration prefix that should be used to map configuration properties to the annotated class.
      Returns:
      the configuration prefix.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object