Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add 'deprecated' field to configuration meta-data

Browse Source 
Update the ConfigurationMetadataAnnotationProcessor to detect the
@Deprecated annotation on getters or setters.

Fixes gh-1846
This commit is contained in:
Phillip Webb
2014-11-19 14:15:35 -08:00
parent 31253d0d76
commit f75b266d64
7 changed files with 63 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/ConfigurationMetadataAnnotationProcessor.java
View File

@@ -183,8 +183,10 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
String sourceType = this.typeUtils.getType(element);
String description = this.typeUtils.getJavaDoc(field);
Object defaultValue = fieldValues.get(name);
boolean deprecated = hasDeprecateAnnotation(getter)
|| hasDeprecateAnnotation(setter);
this.metadata.add(ItemMetadata.newProperty(prefix, name, dataType,
sourceType, null, description, defaultValue));
sourceType, null, description, defaultValue, deprecated));
}
}
}
@@ -217,6 +219,10 @@ public class ConfigurationMetadataAnnotationProcessor extends AbstractProcessor
}
}
private boolean hasDeprecateAnnotation(Element element) {
return getAnnotation(element, "java.lang.Deprecated") != null;
}
private AnnotationMirror getAnnotation(Element element, String type) {
if (element != null) {
for (AnnotationMirror annotation : element.getAnnotationMirrors()) {

20
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/ItemMetadata.java
View File

@@ -36,13 +36,15 @@ public class ItemMetadata implements Comparable<ItemMetadata> {
private final String sourceType;
private String sourceMethod;
private final String sourceMethod;
private Object defaultValue;
private final Object defaultValue;
private final boolean deprecated;
ItemMetadata(ItemType itemType, String prefix, String name, String type,
String sourceType, String sourceMethod, String description,
Object defaultValue) {
Object defaultValue, boolean deprecated) {
super();
this.itemType = itemType;
this.name = buildName(prefix, name);
@@ -51,6 +53,7 @@ public class ItemMetadata implements Comparable<ItemMetadata> {
this.sourceMethod = sourceMethod;
this.description = description;
this.defaultValue = defaultValue;
this.deprecated = deprecated;
}
private String buildName(String prefix, String name) {
@@ -93,6 +96,10 @@ public class ItemMetadata implements Comparable<ItemMetadata> {
return this.defaultValue;
}
public boolean isDeprecated() {
return this.deprecated;
}
@Override
public String toString() {
StringBuilder string = new StringBuilder(this.name);
@@ -100,6 +107,7 @@ public class ItemMetadata implements Comparable<ItemMetadata> {
buildToStringProperty(string, "sourceType", this.sourceType);
buildToStringProperty(string, "description", this.description);
buildToStringProperty(string, "defaultValue", this.defaultValue);
buildToStringProperty(string, "deprecated", this.deprecated);
return string.toString();
}
@@ -118,14 +126,14 @@ public class ItemMetadata implements Comparable<ItemMetadata> {
public static ItemMetadata newGroup(String name, String type, String sourceType,
String sourceMethod) {
return new ItemMetadata(ItemType.GROUP, name, null, type, sourceType,
sourceMethod, null, null);
sourceMethod, null, null, false);
}
public static ItemMetadata newProperty(String prefix, String name, String type,
String sourceType, String sourceMethod, String description,
Object defaultValue) {
Object defaultValue, boolean deprecated) {
return new ItemMetadata(ItemType.PROPERTY, prefix, name, type, sourceType,
sourceMethod, description, defaultValue);
sourceMethod, description, defaultValue, deprecated);
}
/**

6
spring-boot-tools/spring-boot-configuration-processor/src/main/java/org/springframework/boot/configurationprocessor/metadata/JsonMarshaller.java
View File

@@ -68,6 +68,9 @@ public class JsonMarshaller {
putIfPresent(jsonObject, "sourceType", item.getSourceType());
putIfPresent(jsonObject, "sourceMethod", item.getSourceMethod());
putIfPresent(jsonObject, "defaultValue", item.getDefaultValue());
if (item.isDeprecated()) {
jsonObject.put("deprecated", true);
}
return jsonObject;
}
@@ -103,8 +106,9 @@ public class JsonMarshaller {
String sourceType = object.optString("sourceType", null);
String sourceMethod = object.optString("sourceMethod", null);
Object defaultValue = object.opt("defaultValue");
boolean deprecated = object.optBoolean("deprecated");
return new ItemMetadata(itemType, name, null, type, sourceType, sourceMethod,
description, defaultValue);
description, defaultValue, deprecated);
}
private String toString(InputStream inputStream) throws IOException {