Annotation Interface DeprecatedConfigurationProperty
Indicates that a getter in a
@ConfigurationProperties
object is deprecated. This annotation has no bearing on the actual binding processes,
but it is used by the spring-boot-configuration-processor
to add deprecation
meta-data.
This annotation must be used on the getter of the deprecated element.
- Since:
- 1.3.0
- Author:
- Phillip Webb, Scott Frederick
-
Optional Element Summary
-
Element Details
-
reason
String reasonThe reason for the deprecation.- Returns:
- the deprecation reason
- Default:
- ""
-
replacement
String replacementThe field that should be used instead (if any).- Returns:
- the replacement field
- Default:
- ""
-
since
String sinceThe version in which the property became deprecated.- Returns:
- the version
- Default:
- ""
-