org.springframework.boot.context.properties.bind

Annotation Type DefaultValue



  • @Retention(value=RUNTIME)
     @Target(value=PARAMETER)
     @Documented
    public @interface DefaultValue
    Annotation that can be used to specify the default value when binding to an immutable property. This annotation can also be used with nested properties to indicate that a value should always be bound (rather than binding null). The value from this annotation will only be used if the property is not found in the property sources used by the Binder. For example, if the property is present in the Environment when binding to @ConfigurationProperties, the default value for the property will not be used even if the property value is empty.

    NOTE: This annotation does not support property placeholder resolution and the value must be constant.

    Since:
    2.2.0
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.String[] value
      The default value of the property.
    • Element Detail

      • value

        public abstract java.lang.String[] value
        The default value of the property. Can be an array of values for collection or array-based properties.
        Returns:
        the default value of the property.
        Default:
        {}