Add since attribute to @DeprecatedConfigurationProperty annotation

Closes gh-36482
This commit is contained in:
Scott Frederick 2023-07-28 16:20:23 -05:00
parent 0646eabd4a
commit 2e50d11d86
18 changed files with 116 additions and 64 deletions

View File

@ -198,6 +198,11 @@ The JSON object contained in the `deprecation` attribute of each `properties` el
| String | String
| The full name of the property that _replaces_ this deprecated property. | The full name of the property that _replaces_ this deprecated property.
If there is no replacement for this property, it may be omitted. If there is no replacement for this property, it may be omitted.
| `since`
| String
| The version in which the property became deprecated.
Can be omitted.
|=== |===
NOTE: Prior to Spring Boot 1.3, a single `deprecated` boolean attribute can be used instead of the `deprecation` element. NOTE: Prior to Spring Boot 1.3, a single `deprecated` boolean attribute can be used instead of the `deprecation` element.

View File

@ -57,6 +57,7 @@ import org.springframework.boot.configurationprocessor.metadata.ItemMetadata;
* @author Phillip Webb * @author Phillip Webb
* @author Kris De Volder * @author Kris De Volder
* @author Jonas Keßler * @author Jonas Keßler
* @author Scott Frederick
* @since 1.2.0 * @since 1.2.0
*/ */
@SupportedAnnotationTypes({ ConfigurationMetadataAnnotationProcessor.AUTO_CONFIGURATION_ANNOTATION, @SupportedAnnotationTypes({ ConfigurationMetadataAnnotationProcessor.AUTO_CONFIGURATION_ANNOTATION,
@ -322,16 +323,11 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
} }
private String getPrefix(AnnotationMirror annotation) { private String getPrefix(AnnotationMirror annotation) {
Map<String, Object> elementValues = this.metadataEnv.getAnnotationElementValues(annotation); String prefix = this.metadataEnv.getAnnotationElementStringValue(annotation, "prefix");
Object prefix = elementValues.get("prefix"); if (prefix != null) {
if (prefix != null && !"".equals(prefix)) { return prefix;
return (String) prefix;
} }
Object value = elementValues.get("value"); return this.metadataEnv.getAnnotationElementStringValue(annotation, "value");
if (value != null && !"".equals(value)) {
return (String) value;
}
return null;
} }
protected ConfigurationMetadata writeMetadata() throws Exception { protected ConfigurationMetadata writeMetadata() throws Exception {

View File

@ -49,6 +49,7 @@ import org.springframework.boot.configurationprocessor.metadata.ItemDeprecation;
* Provide utilities to detect and validate configuration properties. * Provide utilities to detect and validate configuration properties.
* *
* @author Stephane Nicoll * @author Stephane Nicoll
* @author Scott Frederick
*/ */
class MetadataGenerationEnvironment { class MetadataGenerationEnvironment {
@ -174,14 +175,13 @@ class MetadataGenerationEnvironment {
AnnotationMirror annotation = getAnnotation(element, this.deprecatedConfigurationPropertyAnnotation); AnnotationMirror annotation = getAnnotation(element, this.deprecatedConfigurationPropertyAnnotation);
String reason = null; String reason = null;
String replacement = null; String replacement = null;
String since = null;
if (annotation != null) { if (annotation != null) {
Map<String, Object> elementValues = getAnnotationElementValues(annotation); reason = getAnnotationElementStringValue(annotation, "reason");
reason = (String) elementValues.get("reason"); replacement = getAnnotationElementStringValue(annotation, "replacement");
replacement = (String) elementValues.get("replacement"); since = getAnnotationElementStringValue(annotation, "since");
} }
reason = (reason == null || reason.isEmpty()) ? null : reason; return new ItemDeprecation(reason, replacement, since);
replacement = (replacement == null || replacement.isEmpty()) ? null : replacement;
return new ItemDeprecation(reason, replacement);
} }
boolean hasConstructorBindingAnnotation(ExecutableElement element) { boolean hasConstructorBindingAnnotation(ExecutableElement element) {
@ -279,6 +279,16 @@ class MetadataGenerationEnvironment {
return values; return values;
} }
String getAnnotationElementStringValue(AnnotationMirror annotation, String name) {
return annotation.getElementValues()
.entrySet()
.stream()
.filter((element) -> element.getKey().getSimpleName().toString().equals(name))
.map((element) -> asString(getAnnotationValue(element.getValue())))
.findFirst()
.orElse(null);
}
private Object getAnnotationValue(AnnotationValue annotationValue) { private Object getAnnotationValue(AnnotationValue annotationValue) {
Object value = annotationValue.getValue(); Object value = annotationValue.getValue();
if (value instanceof List) { if (value instanceof List) {
@ -289,6 +299,10 @@ class MetadataGenerationEnvironment {
return value; return value;
} }
private String asString(Object value) {
return (value == null || value.toString().isEmpty()) ? null : (String) value;
}
TypeElement getConfigurationPropertiesAnnotationElement() { TypeElement getConfigurationPropertiesAnnotationElement() {
return this.elements.getTypeElement(this.configurationPropertiesAnnotation); return this.elements.getTypeElement(this.configurationPropertiesAnnotation);
} }

View File

@ -91,7 +91,7 @@ class PropertyDescriptorResolver {
private String getParameterName(VariableElement parameter) { private String getParameterName(VariableElement parameter) {
AnnotationMirror nameAnnotation = this.environment.getNameAnnotation(parameter); AnnotationMirror nameAnnotation = this.environment.getNameAnnotation(parameter);
if (nameAnnotation != null) { if (nameAnnotation != null) {
return (String) this.environment.getAnnotationElementValues(nameAnnotation).get("value"); return this.environment.getAnnotationElementStringValue(nameAnnotation, "value");
} }
return parameter.getSimpleName().toString(); return parameter.getSimpleName().toString();
} }

View File

@ -136,6 +136,9 @@ public class ConfigurationMetadata {
if (deprecation.getLevel() != null) { if (deprecation.getLevel() != null) {
matchingDeprecation.setLevel(deprecation.getLevel()); matchingDeprecation.setLevel(deprecation.getLevel());
} }
if (deprecation.getSince() != null) {
matchingDeprecation.setSince(deprecation.getSince());
}
} }
} }
} }

View File

@ -20,6 +20,7 @@ package org.springframework.boot.configurationprocessor.metadata;
* Describe an item deprecation. * Describe an item deprecation.
* *
* @author Stephane Nicoll * @author Stephane Nicoll
* @author Scott Frederick
* @since 1.3.0 * @since 1.3.0
*/ */
public class ItemDeprecation { public class ItemDeprecation {
@ -28,19 +29,22 @@ public class ItemDeprecation {
private String replacement; private String replacement;
private String since;
private String level; private String level;
public ItemDeprecation() { public ItemDeprecation() {
this(null, null); this(null, null, null);
} }
public ItemDeprecation(String reason, String replacement) { public ItemDeprecation(String reason, String replacement, String since) {
this(reason, replacement, null); this(reason, replacement, since, null);
} }
public ItemDeprecation(String reason, String replacement, String level) { public ItemDeprecation(String reason, String replacement, String since, String level) {
this.reason = reason; this.reason = reason;
this.replacement = replacement; this.replacement = replacement;
this.since = since;
this.level = level; this.level = level;
} }
@ -60,6 +64,14 @@ public class ItemDeprecation {
this.replacement = replacement; this.replacement = replacement;
} }
public String getSince() {
return this.since;
}
public void setSince(String since) {
this.since = since;
}
public String getLevel() { public String getLevel() {
return this.level; return this.level;
} }
@ -78,7 +90,7 @@ public class ItemDeprecation {
} }
ItemDeprecation other = (ItemDeprecation) o; ItemDeprecation other = (ItemDeprecation) o;
return nullSafeEquals(this.reason, other.reason) && nullSafeEquals(this.replacement, other.replacement) return nullSafeEquals(this.reason, other.reason) && nullSafeEquals(this.replacement, other.replacement)
&& nullSafeEquals(this.level, other.level); && nullSafeEquals(this.level, other.level) && nullSafeEquals(this.since, other.since);
} }
@Override @Override
@ -86,13 +98,14 @@ public class ItemDeprecation {
int result = nullSafeHashCode(this.reason); int result = nullSafeHashCode(this.reason);
result = 31 * result + nullSafeHashCode(this.replacement); result = 31 * result + nullSafeHashCode(this.replacement);
result = 31 * result + nullSafeHashCode(this.level); result = 31 * result + nullSafeHashCode(this.level);
result = 31 * result + nullSafeHashCode(this.since);
return result; return result;
} }
@Override @Override
public String toString() { public String toString() {
return "ItemDeprecation{reason='" + this.reason + '\'' + ", replacement='" + this.replacement + '\'' return "ItemDeprecation{reason='" + this.reason + '\'' + ", replacement='" + this.replacement + '\''
+ ", level='" + this.level + '\'' + '}'; + ", level='" + this.level + '\'' + ", since='" + this.since + '\'' + '}';
} }
private boolean nullSafeEquals(Object o1, Object o2) { private boolean nullSafeEquals(Object o1, Object o2) {

View File

@ -83,6 +83,9 @@ class JsonConverter {
if (deprecation.getReplacement() != null) { if (deprecation.getReplacement() != null) {
deprecationJsonObject.put("replacement", deprecation.getReplacement()); deprecationJsonObject.put("replacement", deprecation.getReplacement());
} }
if (deprecation.getSince() != null) {
deprecationJsonObject.put("since", deprecation.getSince());
}
jsonObject.put("deprecation", deprecationJsonObject); jsonObject.put("deprecation", deprecationJsonObject);
} }
return jsonObject; return jsonObject;

View File

@ -105,6 +105,7 @@ public class JsonMarshaller {
deprecation.setLevel(deprecationJsonObject.optString("level", null)); deprecation.setLevel(deprecationJsonObject.optString("level", null));
deprecation.setReason(deprecationJsonObject.optString("reason", null)); deprecation.setReason(deprecationJsonObject.optString("reason", null));
deprecation.setReplacement(deprecationJsonObject.optString("replacement", null)); deprecation.setReplacement(deprecationJsonObject.optString("replacement", null));
deprecation.setSince(deprecationJsonObject.optString("since", null));
return deprecation; return deprecation;
} }
return object.optBoolean("deprecated") ? new ItemDeprecation() : null; return object.optBoolean("deprecated") ? new ItemDeprecation() : null;

View File

@ -104,12 +104,12 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
.fromSource(SimpleProperties.class) .fromSource(SimpleProperties.class)
.withDescription("The name of this simple properties.") .withDescription("The name of this simple properties.")
.withDefaultValue("boot") .withDefaultValue("boot")
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata).has(Metadata.withProperty("simple.flag", Boolean.class) assertThat(metadata).has(Metadata.withProperty("simple.flag", Boolean.class)
.withDefaultValue(false) .withDefaultValue(false)
.fromSource(SimpleProperties.class) .fromSource(SimpleProperties.class)
.withDescription("A simple flag.") .withDescription("A simple flag.")
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata).has(Metadata.withProperty("simple.comparator")); assertThat(metadata).has(Metadata.withProperty("simple.comparator"));
assertThat(metadata).doesNotHave(Metadata.withProperty("simple.counter")); assertThat(metadata).doesNotHave(Metadata.withProperty("simple.counter"));
assertThat(metadata).doesNotHave(Metadata.withProperty("simple.size")); assertThat(metadata).doesNotHave(Metadata.withProperty("simple.size"));
@ -188,10 +188,9 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
ConfigurationMetadata metadata = compile(type); ConfigurationMetadata metadata = compile(type);
assertThat(metadata).has(Metadata.withGroup("deprecated").fromSource(type)); assertThat(metadata).has(Metadata.withGroup("deprecated").fromSource(type));
assertThat(metadata) assertThat(metadata)
.has(Metadata.withProperty("deprecated.name", String.class).fromSource(type).withDeprecation(null, null)); .has(Metadata.withProperty("deprecated.name", String.class).fromSource(type).withDeprecation());
assertThat(metadata).has(Metadata.withProperty("deprecated.description", String.class) assertThat(metadata)
.fromSource(type) .has(Metadata.withProperty("deprecated.description", String.class).fromSource(type).withDeprecation());
.withDeprecation(null, null));
} }
@Test @Test
@ -202,7 +201,7 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
assertThat(metadata).has(Metadata.withProperty("singledeprecated.new-name", String.class).fromSource(type)); assertThat(metadata).has(Metadata.withProperty("singledeprecated.new-name", String.class).fromSource(type));
assertThat(metadata).has(Metadata.withProperty("singledeprecated.name", String.class) assertThat(metadata).has(Metadata.withProperty("singledeprecated.name", String.class)
.fromSource(type) .fromSource(type)
.withDeprecation("renamed", "singledeprecated.new-name")); .withDeprecation("renamed", "singledeprecated.new-name", "1.2.3"));
} }
@Test @Test
@ -210,9 +209,8 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
Class<?> type = DeprecatedFieldSingleProperty.class; Class<?> type = DeprecatedFieldSingleProperty.class;
ConfigurationMetadata metadata = compile(type); ConfigurationMetadata metadata = compile(type);
assertThat(metadata).has(Metadata.withGroup("singlefielddeprecated").fromSource(type)); assertThat(metadata).has(Metadata.withGroup("singlefielddeprecated").fromSource(type));
assertThat(metadata).has(Metadata.withProperty("singlefielddeprecated.name", String.class) assertThat(metadata)
.fromSource(type) .has(Metadata.withProperty("singlefielddeprecated.name", String.class).fromSource(type).withDeprecation());
.withDeprecation(null, null));
} }
@Test @Test
@ -246,7 +244,7 @@ class ConfigurationMetadataAnnotationProcessorTests extends AbstractMetadataGene
assertThat(metadata).has(Metadata.withGroup("deprecated-record").fromSource(type)); assertThat(metadata).has(Metadata.withGroup("deprecated-record").fromSource(type));
assertThat(metadata).has(Metadata.withProperty("deprecated-record.alpha", String.class) assertThat(metadata).has(Metadata.withProperty("deprecated-record.alpha", String.class)
.fromSource(type) .fromSource(type)
.withDeprecation("some-reason", null)); .withDeprecation("some-reason", null, null));
assertThat(metadata).has(Metadata.withProperty("deprecated-record.bravo", String.class).fromSource(type)); assertThat(metadata).has(Metadata.withProperty("deprecated-record.bravo", String.class).fromSource(type));
} }

View File

@ -43,7 +43,7 @@ class ImmutablePropertiesMetadataGenerationTests extends AbstractMetadataGenerat
.withDefaultValue(false) .withDefaultValue(false)
.fromSource(ImmutableSimpleProperties.class) .fromSource(ImmutableSimpleProperties.class)
.withDescription("A simple flag.") .withDescription("A simple flag.")
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata).has(Metadata.withProperty("immutable.comparator")); assertThat(metadata).has(Metadata.withProperty("immutable.comparator"));
assertThat(metadata).has(Metadata.withProperty("immutable.counter")); assertThat(metadata).has(Metadata.withProperty("immutable.counter"));
assertThat(metadata.getItems()).hasSize(5); assertThat(metadata.getItems()).hasSize(5);

View File

@ -139,10 +139,8 @@ class LombokMetadataGenerationTests extends AbstractMetadataGenerationTests {
.withDescription("Name description.")); .withDescription("Name description."));
assertThat(metadata).has(Metadata.withProperty(prefix + ".description")); assertThat(metadata).has(Metadata.withProperty(prefix + ".description"));
assertThat(metadata).has(Metadata.withProperty(prefix + ".counter")); assertThat(metadata).has(Metadata.withProperty(prefix + ".counter"));
assertThat(metadata).has(Metadata.withProperty(prefix + ".number") assertThat(metadata)
.fromSource(source) .has(Metadata.withProperty(prefix + ".number").fromSource(source).withDefaultValue(0).withDeprecation());
.withDefaultValue(0)
.withDeprecation(null, null));
assertThat(metadata).has(Metadata.withProperty(prefix + ".items")); assertThat(metadata).has(Metadata.withProperty(prefix + ".items"));
assertThat(metadata).doesNotHave(Metadata.withProperty(prefix + ".ignored")); assertThat(metadata).doesNotHave(Metadata.withProperty(prefix + ".ignored"));
} }

View File

@ -74,7 +74,7 @@ class MergeMetadataGenerationTests extends AbstractMetadataGenerationTests {
assertThat(metadata).has(Metadata.withProperty("simple.flag", Boolean.class) assertThat(metadata).has(Metadata.withProperty("simple.flag", Boolean.class)
.fromSource(SimpleProperties.class) .fromSource(SimpleProperties.class)
.withDescription("A simple flag.") .withDescription("A simple flag.")
.withDeprecation(null, null) .withDeprecation()
.withDefaultValue(true)); .withDefaultValue(true));
assertThat(metadata.getItems()).hasSize(4); assertThat(metadata.getItems()).hasSize(4);
} }
@ -125,36 +125,36 @@ class MergeMetadataGenerationTests extends AbstractMetadataGenerationTests {
@Test @Test
void mergeExistingPropertyDeprecation() throws Exception { void mergeExistingPropertyDeprecation() throws Exception {
ItemMetadata property = ItemMetadata.newProperty("simple", "comparator", null, null, null, null, null, ItemMetadata property = ItemMetadata.newProperty("simple", "comparator", null, null, null, null, null,
new ItemDeprecation("Don't use this.", "simple.complex-comparator", "error")); new ItemDeprecation("Don't use this.", "simple.complex-comparator", "1.2.3", "error"));
String additionalMetadata = buildAdditionalMetadata(property); String additionalMetadata = buildAdditionalMetadata(property);
ConfigurationMetadata metadata = compile(additionalMetadata, SimpleProperties.class); ConfigurationMetadata metadata = compile(additionalMetadata, SimpleProperties.class);
assertThat(metadata).has(Metadata.withProperty("simple.comparator", "java.util.Comparator<?>") assertThat(metadata).has(Metadata.withProperty("simple.comparator", "java.util.Comparator<?>")
.fromSource(SimpleProperties.class) .fromSource(SimpleProperties.class)
.withDeprecation("Don't use this.", "simple.complex-comparator", "error")); .withDeprecation("Don't use this.", "simple.complex-comparator", "1.2.3", "error"));
assertThat(metadata.getItems()).hasSize(4); assertThat(metadata.getItems()).hasSize(4);
} }
@Test @Test
void mergeExistingPropertyDeprecationOverride() throws Exception { void mergeExistingPropertyDeprecationOverride() throws Exception {
ItemMetadata property = ItemMetadata.newProperty("singledeprecated", "name", null, null, null, null, null, ItemMetadata property = ItemMetadata.newProperty("singledeprecated", "name", null, null, null, null, null,
new ItemDeprecation("Don't use this.", "single.name")); new ItemDeprecation("Don't use this.", "single.name", "1.2.3"));
String additionalMetadata = buildAdditionalMetadata(property); String additionalMetadata = buildAdditionalMetadata(property);
ConfigurationMetadata metadata = compile(additionalMetadata, DeprecatedSingleProperty.class); ConfigurationMetadata metadata = compile(additionalMetadata, DeprecatedSingleProperty.class);
assertThat(metadata).has(Metadata.withProperty("singledeprecated.name", String.class.getName()) assertThat(metadata).has(Metadata.withProperty("singledeprecated.name", String.class.getName())
.fromSource(DeprecatedSingleProperty.class) .fromSource(DeprecatedSingleProperty.class)
.withDeprecation("Don't use this.", "single.name")); .withDeprecation("Don't use this.", "single.name", "1.2.3"));
assertThat(metadata.getItems()).hasSize(3); assertThat(metadata.getItems()).hasSize(3);
} }
@Test @Test
void mergeExistingPropertyDeprecationOverrideLevel() throws Exception { void mergeExistingPropertyDeprecationOverrideLevel() throws Exception {
ItemMetadata property = ItemMetadata.newProperty("singledeprecated", "name", null, null, null, null, null, ItemMetadata property = ItemMetadata.newProperty("singledeprecated", "name", null, null, null, null, null,
new ItemDeprecation(null, null, "error")); new ItemDeprecation(null, null, null, "error"));
String additionalMetadata = buildAdditionalMetadata(property); String additionalMetadata = buildAdditionalMetadata(property);
ConfigurationMetadata metadata = compile(additionalMetadata, DeprecatedSingleProperty.class); ConfigurationMetadata metadata = compile(additionalMetadata, DeprecatedSingleProperty.class);
assertThat(metadata).has(Metadata.withProperty("singledeprecated.name", String.class.getName()) assertThat(metadata).has(Metadata.withProperty("singledeprecated.name", String.class.getName())
.fromSource(DeprecatedSingleProperty.class) .fromSource(DeprecatedSingleProperty.class)
.withDeprecation("renamed", "singledeprecated.new-name", "error")); .withDeprecation("renamed", "singledeprecated.new-name", "1.2.3", "error"));
assertThat(metadata.getItems()).hasSize(3); assertThat(metadata.getItems()).hasSize(3);
} }
@ -175,7 +175,7 @@ class MergeMetadataGenerationTests extends AbstractMetadataGenerationTests {
.fromSource(SimpleProperties.class) .fromSource(SimpleProperties.class)
.withDescription("The name of this simple properties.") .withDescription("The name of this simple properties.")
.withDefaultValue("boot") .withDefaultValue("boot")
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata) assertThat(metadata)
.has(Metadata.withHint("simple.the-name").withValue(0, "boot", "Bla bla").withValue(1, "spring", null)); .has(Metadata.withHint("simple.the-name").withValue(0, "boot", "Bla bla").withValue(1, "spring", null));
} }
@ -189,7 +189,7 @@ class MergeMetadataGenerationTests extends AbstractMetadataGenerationTests {
.fromSource(SimpleProperties.class) .fromSource(SimpleProperties.class)
.withDescription("The name of this simple properties.") .withDescription("The name of this simple properties.")
.withDefaultValue("boot") .withDefaultValue("boot")
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata).has(Metadata.withHint("simple.the-name").withValue(0, "boot", "Bla bla")); assertThat(metadata).has(Metadata.withHint("simple.the-name").withValue(0, "boot", "Bla bla"));
} }
@ -203,18 +203,19 @@ class MergeMetadataGenerationTests extends AbstractMetadataGenerationTests {
.fromSource(SimpleProperties.class) .fromSource(SimpleProperties.class)
.withDescription("The name of this simple properties.") .withDescription("The name of this simple properties.")
.withDefaultValue("boot") .withDefaultValue("boot")
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata).has( assertThat(metadata).has(
Metadata.withHint("simple.the-name").withProvider("first", "target", "org.foo").withProvider("second")); Metadata.withHint("simple.the-name").withProvider("first", "target", "org.foo").withProvider("second"));
} }
@Test @Test
void mergingOfAdditionalDeprecation() throws Exception { void mergingOfAdditionalDeprecation() throws Exception {
String deprecations = buildPropertyDeprecations(ItemMetadata.newProperty("simple", "wrongName", String deprecations = buildPropertyDeprecations(
"java.lang.String", null, null, null, null, new ItemDeprecation("Lame name.", "simple.the-name"))); ItemMetadata.newProperty("simple", "wrongName", "java.lang.String", null, null, null, null,
new ItemDeprecation("Lame name.", "simple.the-name", "1.2.3")));
ConfigurationMetadata metadata = compile(deprecations, SimpleProperties.class); ConfigurationMetadata metadata = compile(deprecations, SimpleProperties.class);
assertThat(metadata).has(Metadata.withProperty("simple.wrong-name", String.class) assertThat(metadata).has(Metadata.withProperty("simple.wrong-name", String.class)
.withDeprecation("Lame name.", "simple.the-name")); .withDeprecation("Lame name.", "simple.the-name", "1.2.3"));
} }
@Test @Test
@ -268,6 +269,9 @@ class MergeMetadataGenerationTests extends AbstractMetadataGenerationTests {
if (deprecation.getReplacement() != null) { if (deprecation.getReplacement() != null) {
deprecationJson.put("replacement", deprecation.getReplacement()); deprecationJson.put("replacement", deprecation.getReplacement());
} }
if (deprecation.getSince() != null) {
deprecationJson.put("since", deprecation.getSince());
}
jsonObject.put("deprecation", deprecationJson); jsonObject.put("deprecation", deprecationJson);
} }
propertiesArray.put(jsonObject); propertiesArray.put(jsonObject);

View File

@ -114,11 +114,11 @@ class MethodBasedMetadataGenerationTests extends AbstractMetadataGenerationTests
assertThat(metadata).has(Metadata.withGroup("foo").fromSource(type)); assertThat(metadata).has(Metadata.withGroup("foo").fromSource(type));
assertThat(metadata).has(Metadata.withProperty("foo.name", String.class) assertThat(metadata).has(Metadata.withProperty("foo.name", String.class)
.fromSource(DeprecatedMethodConfig.Foo.class) .fromSource(DeprecatedMethodConfig.Foo.class)
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata).has(Metadata.withProperty("foo.flag", Boolean.class) assertThat(metadata).has(Metadata.withProperty("foo.flag", Boolean.class)
.withDefaultValue(false) .withDefaultValue(false)
.fromSource(DeprecatedMethodConfig.Foo.class) .fromSource(DeprecatedMethodConfig.Foo.class)
.withDeprecation(null, null)); .withDeprecation());
} }
@Test @Test
@ -129,11 +129,11 @@ class MethodBasedMetadataGenerationTests extends AbstractMetadataGenerationTests
assertThat(metadata).has(Metadata.withGroup("foo").fromSource(type)); assertThat(metadata).has(Metadata.withGroup("foo").fromSource(type));
assertThat(metadata).has(Metadata.withProperty("foo.name", String.class) assertThat(metadata).has(Metadata.withProperty("foo.name", String.class)
.fromSource(org.springframework.boot.configurationsample.method.DeprecatedClassMethodConfig.Foo.class) .fromSource(org.springframework.boot.configurationsample.method.DeprecatedClassMethodConfig.Foo.class)
.withDeprecation(null, null)); .withDeprecation());
assertThat(metadata).has(Metadata.withProperty("foo.flag", Boolean.class) assertThat(metadata).has(Metadata.withProperty("foo.flag", Boolean.class)
.withDefaultValue(false) .withDefaultValue(false)
.fromSource(org.springframework.boot.configurationsample.method.DeprecatedClassMethodConfig.Foo.class) .fromSource(org.springframework.boot.configurationsample.method.DeprecatedClassMethodConfig.Foo.class)
.withDeprecation(null, null)); .withDeprecation());
} }
} }

View File

@ -39,7 +39,7 @@ class JsonMarshallerTests {
void marshallAndUnmarshal() throws Exception { void marshallAndUnmarshal() throws Exception {
ConfigurationMetadata metadata = new ConfigurationMetadata(); ConfigurationMetadata metadata = new ConfigurationMetadata();
metadata.add(ItemMetadata.newProperty("a", "b", StringBuffer.class.getName(), InputStream.class.getName(), metadata.add(ItemMetadata.newProperty("a", "b", StringBuffer.class.getName(), InputStream.class.getName(),
"sourceMethod", "desc", "x", new ItemDeprecation("Deprecation comment", "b.c.d"))); "sourceMethod", "desc", "x", new ItemDeprecation("Deprecation comment", "b.c.d", "1.2.3")));
metadata.add(ItemMetadata.newProperty("b.c.d", null, null, null, null, null, null, null)); metadata.add(ItemMetadata.newProperty("b.c.d", null, null, null, null, null, null, null));
metadata.add(ItemMetadata.newProperty("c", null, null, null, null, null, 123, null)); metadata.add(ItemMetadata.newProperty("c", null, null, null, null, null, 123, null));
metadata.add(ItemMetadata.newProperty("d", null, null, null, null, null, true, null)); metadata.add(ItemMetadata.newProperty("d", null, null, null, null, null, true, null));
@ -59,7 +59,7 @@ class JsonMarshallerTests {
.fromSource(InputStream.class) .fromSource(InputStream.class)
.withDescription("desc") .withDescription("desc")
.withDefaultValue("x") .withDefaultValue("x")
.withDeprecation("Deprecation comment", "b.c.d")); .withDeprecation("Deprecation comment", "b.c.d", "1.2.3"));
assertThat(read).has(Metadata.withProperty("b.c.d")); assertThat(read).has(Metadata.withProperty("b.c.d"));
assertThat(read).has(Metadata.withProperty("c").withDefaultValue(123)); assertThat(read).has(Metadata.withProperty("c").withDefaultValue(123));
assertThat(read).has(Metadata.withProperty("d").withDefaultValue(true)); assertThat(read).has(Metadata.withProperty("d").withDefaultValue(true));
@ -96,10 +96,10 @@ class JsonMarshallerTests {
ConfigurationMetadata metadata = new ConfigurationMetadata(); ConfigurationMetadata metadata = new ConfigurationMetadata();
metadata.add(ItemMetadata.newProperty("com.example.bravo", "bbb", null, null, null, null, null, null)); metadata.add(ItemMetadata.newProperty("com.example.bravo", "bbb", null, null, null, null, null, null));
metadata.add(ItemMetadata.newProperty("com.example.bravo", "aaa", null, null, null, null, null, metadata.add(ItemMetadata.newProperty("com.example.bravo", "aaa", null, null, null, null, null,
new ItemDeprecation(null, null, "warning"))); new ItemDeprecation(null, null, null, "warning")));
metadata.add(ItemMetadata.newProperty("com.example.alpha", "ddd", null, null, null, null, null, null)); metadata.add(ItemMetadata.newProperty("com.example.alpha", "ddd", null, null, null, null, null, null));
metadata.add(ItemMetadata.newProperty("com.example.alpha", "ccc", null, null, null, null, null, metadata.add(ItemMetadata.newProperty("com.example.alpha", "ccc", null, null, null, null, null,
new ItemDeprecation(null, null, "warning"))); new ItemDeprecation(null, null, null, "warning")));
ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
JsonMarshaller marshaller = new JsonMarshaller(); JsonMarshaller marshaller = new JsonMarshaller();
marshaller.write(metadata, outputStream); marshaller.write(metadata, outputStream);

View File

@ -193,13 +193,17 @@ public final class Metadata {
this.description, defaultValue, this.deprecation); this.description, defaultValue, this.deprecation);
} }
public MetadataItemCondition withDeprecation(String reason, String replacement) { public MetadataItemCondition withDeprecation() {
return withDeprecation(reason, replacement, null); return withDeprecation(null, null, null, null);
} }
public MetadataItemCondition withDeprecation(String reason, String replacement, String level) { public MetadataItemCondition withDeprecation(String reason, String replacement, String since) {
return withDeprecation(reason, replacement, since, null);
}
public MetadataItemCondition withDeprecation(String reason, String replacement, String since, String level) {
return new MetadataItemCondition(this.itemType, this.name, this.type, this.sourceType, this.sourceMethod, return new MetadataItemCondition(this.itemType, this.name, this.type, this.sourceType, this.sourceMethod,
this.description, this.defaultValue, new ItemDeprecation(reason, replacement, level)); this.description, this.defaultValue, new ItemDeprecation(reason, replacement, since, level));
} }
public MetadataItemCondition withNoDeprecation() { public MetadataItemCondition withNoDeprecation() {

View File

@ -50,4 +50,10 @@ public @interface DeprecatedConfigurationProperty {
*/ */
String replacement() default ""; String replacement() default "";
/**
* The version in which the property became deprecated.
* @return the version
*/
String since() default "";
} }

View File

@ -30,7 +30,7 @@ public class DeprecatedSingleProperty {
private String newName; private String newName;
@Deprecated @Deprecated
@DeprecatedConfigurationProperty(reason = "renamed", replacement = "singledeprecated.new-name") @DeprecatedConfigurationProperty(reason = "renamed", replacement = "singledeprecated.new-name", since = "1.2.3")
public String getName() { public String getName() {
return getNewName(); return getNewName();
} }

View File

@ -31,6 +31,7 @@ import java.lang.annotation.Target;
* This annotation <strong>must</strong> be used on the getter of the deprecated element. * This annotation <strong>must</strong> be used on the getter of the deprecated element.
* *
* @author Phillip Webb * @author Phillip Webb
* @author Scott Frederick
* @since 1.3.0 * @since 1.3.0
*/ */
@Target(ElementType.METHOD) @Target(ElementType.METHOD)
@ -50,4 +51,10 @@ public @interface DeprecatedConfigurationProperty {
*/ */
String replacement() default ""; String replacement() default "";
/**
* The version in which the property became deprecated.
* @return the version
*/
String since() default "";
} }