Spring/spring-boot
Spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2024-08-29 03:06:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document DeprecatedConfigurationProperty

Browse Source 
Closes gh-5118
This commit is contained in:
Stephane Nicoll 2016-02-10 11:43:37 +01:00
parent a1fefb15ba
commit 6710c05750
1 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc
View File

@ -222,6 +222,40 @@ the `deprecation` element. This is still supported in a deprecated fashion and s
be used. If no reason and replacement are available, an empty `deprecation` object should be
set.
Deprecation can also be specified declaratively in code by adding the
`@DeprecatedConfigurationProperty` annotation to the getter exposing the deprecated
property. For instance, let's assume the `app.foo.target` property was confusing and
was renamed to `app.foo.name`
[source,java,indent=0]
----
@ConfigurationProperties("app.foo")
public class FooProperties {
private String name;
public String getName() { ... }
public void setName(String name) { ... }
@DeprecatedConfigurationProperty(replacement = "app.foo.name")
@Deprecated
public String getTarget() {
return getName();
}
@Deprecated
public void setTarget(String target) {
setName(target);
}
}
----
The code above makes sure that the deprecated property still works (delegating
to the `name` property behind the scenes). Once the `getTarget` and `setTarget`
methods can be removed from your public API, the automatic deprecation hint in the
meta-data will go away as well.
[[configuration-metadata-hints-attributes]]
==== Hint Attributes