Annotation Interface Config

@Experimental @Documented @Retention(CLASS) @Target(FIELD) public @interface Config
Annotation used to mark fields that represent configuration properties. This annotation provides metadata about how the configuration property should be handled, including its source, type, default value, and whether it's read-only.
Since:
4.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Config.Source
    Property source, which determines when and where the property will be read from or set for consumption.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    defaultValue
    Specifies the default value of the configuration property.
    boolean
    readOnly
    Specifies whether the configuration property is read-only.
    Config.Source
    source
    Specifies the source of the configuration property, which determines when and where the property will be read from or set for consumption in the Maven build lifecycle.
    String
    type
    Specifies the type of the configuration property.

  • Element Details

    • source

      Config.Source source
      Specifies the source of the configuration property, which determines when and where the property will be read from or set for consumption in the Maven build lifecycle. The source indicates whether the property is: - Set by Maven itself at startup (SYSTEM_PROPERTIES) - Configured by users through external means like CLI options (USER_PROPERTIES) - Defined in the project's POM file (MODEL)
      Returns:
      the source of the configuration property, defaults to USER_PROPERTIES
      See Also:
      Default:
      USER_PROPERTIES

    • type

      String type
      Specifies the type of the configuration property.
      Returns:
      the fully qualified class name of the property type, defaults to "java.lang.String"
      Default:
      "java.lang.String"

    • defaultValue

      String defaultValue
      Specifies the default value of the configuration property.
      Returns:
      the default value as a string, defaults to empty string
      Default:
      ""

    • readOnly

      boolean readOnly
      Specifies whether the configuration property is read-only.
      Returns:
      true if the property is read-only, false otherwise
      Default:
      false