#295 Pass through @JacksonXmlProperty annotations

Author: alicederyn

build.gradle

@@ -53,6 +53,7 @@ dependencies {
   testCompile jackson('databind')
   testCompile jackson('datatype-guava')
   testCompile jackson('datatype-jdk8')
+  testCompile jackson('dataformat-xml')
   testCompile javassist
   testCompile junit
   testCompile mockito
@@ -63,6 +64,8 @@ String jackson(String pkg) {
   String namespace
   if (pkg.startsWith('datatype-')) {
     namespace = 'datatype'
+  } else if (pkg.startsWith('dataformat-')) {
+    namespace = 'dataformat'
   } else {
     namespace = 'core'
   }

src/main/java/org/inferred/freebuilder/processor/JacksonSupport.java

@@ -21,6 +21,8 @@ class JacksonSupport {
       "com.fasterxml.jackson.databind.annotation.JsonDeserialize";
   private static final QualifiedName JSON_PROPERTY =
       QualifiedName.of("com.fasterxml.jackson.annotation", "JsonProperty");
+  private static final QualifiedName JACKSON_XML_PROPERTY =
+      QualifiedName.of("com.fasterxml.jackson.dataformat.xml.annotation", "JacksonXmlProperty");
   /** Annotations which disable automatic generation of JsonProperty annotations. */
   private static final Set<QualifiedName> DISABLE_PROPERTY_ANNOTATIONS = ImmutableSet.of(
       QualifiedName.of("com.fasterxml.jackson.annotation", "JsonAnyGetter"),
@@ -39,13 +41,21 @@ private JacksonSupport() {}
 
   public void addJacksonAnnotations(
       Property.Builder resultBuilder, ExecutableElement getterMethod) {
-    Optional<AnnotationMirror> annotation = findAnnotationMirror(getterMethod, JSON_PROPERTY);
-    if (annotation.isPresent()) {
-      resultBuilder.addAccessorAnnotations(Excerpts.add("%s%n", annotation.get()));
+    Optional<AnnotationMirror> jsonPropertyAnnotation = findAnnotationMirror(getterMethod,
+            JSON_PROPERTY);
+    if (jsonPropertyAnnotation.isPresent()) {
+      resultBuilder.addAccessorAnnotations(Excerpts.add("%s%n", jsonPropertyAnnotation.get()));
     } else if (generateDefaultAnnotations(getterMethod)) {
       resultBuilder.addAccessorAnnotations(Excerpts.add(
           "@%s(\"%s\")%n", JSON_PROPERTY, resultBuilder.getName()));
     }
+
+    Optional<AnnotationMirror> jacksonXmlPropertyAnnotation = findAnnotationMirror(getterMethod,
+            JACKSON_XML_PROPERTY);
+    if (jacksonXmlPropertyAnnotation.isPresent()) {
+      resultBuilder
+              .addAccessorAnnotations(Excerpts.add("%s%n", jacksonXmlPropertyAnnotation.get()));
+    }
   }
 
   private static boolean generateDefaultAnnotations(ExecutableElement getterMethod) {

src/test/java/org/inferred/freebuilder/processor/JacksonSupportTest.java

@@ -21,6 +21,7 @@
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 import org.inferred.freebuilder.processor.Analyser.CannotGenerateCodeException;
 import org.inferred.freebuilder.processor.Metadata.Property;
 import org.inferred.freebuilder.processor.util.Excerpt;
@@ -34,6 +35,7 @@
 import org.junit.runners.JUnit4;
 
 import java.util.Map;
+import java.util.Optional;
 
 import javax.lang.model.element.TypeElement;
 
@@ -85,7 +87,25 @@ public void jacksonAnnotationAddedWithExplicitName() throws CannotGenerateCodeEx
     Metadata metadata = analyser.analyse(dataType);
 
     Property property = getOnlyElement(metadata.getProperties());
-    assertPropertyHasJsonPropertyAnnotation(property, "bob");
+    assertPropertyHasAnnotation(property, JsonProperty.class, "@JsonProperty(\"bob\")");
+  }
+  @Test
+  public void jacksonXmlAnnotationAddedWithExplicitName() throws CannotGenerateCodeException {
+    // See also https://github.com/google/FreeBuilder/issues/68
+    TypeElement dataType = model.newType(
+        "package com.example;",
+         "import " + JacksonXmlProperty.class.getName() + ";",
+        "@" + JsonDeserialize.class.getName() + "(builder = DataType.Builder.class)",
+        "public interface DataType {",
+        "  @JacksonXmlProperty(localName=\"b-ob\") int getFooBar();",
+        "  class Builder extends DataType_Builder {}",
+        "}");
+
+    Metadata metadata = analyser.analyse(dataType);
+
+    Property property = getOnlyElement(metadata.getProperties());
+    assertPropertyHasAnnotation(property,
+            JacksonXmlProperty.class, "@JacksonXmlProperty(localName = \"b-ob\")");
   }
 
   @Test
@@ -102,7 +122,7 @@ public void jacksonAnnotationAddedWithImplicitName() throws CannotGenerateCodeEx
     Metadata metadata = analyser.analyse(dataType);
 
     Property property = getOnlyElement(metadata.getProperties());
-    assertPropertyHasJsonPropertyAnnotation(property, "fooBar");
+    assertPropertyHasAnnotation(property, JsonProperty.class, "@JsonProperty(\"fooBar\")");
   }
 
   @Test
@@ -122,11 +142,15 @@ public void jsonAnyGetterAnnotationDisablesImplicitProperty() throws CannotGener
     assertThat(property.getAccessorAnnotations()).named("property accessor annotations").isEmpty();
   }
 
-  private static void assertPropertyHasJsonPropertyAnnotation(
-      Property property, String propertyName) {
-    assertThat(property.getAccessorAnnotations()).named("property accessor annotations").hasSize(1);
-    Excerpt accessorAnnotation = getOnlyElement(property.getAccessorAnnotations());
-    assertThat(asString(accessorAnnotation)).isEqualTo("@JsonProperty(\"" + propertyName + "\")\n");
+  private void assertPropertyHasAnnotation(Property property, Class annotationClass,
+                                           String annotationString) {
+    Optional<Excerpt> annotationExcerpt = property.getAccessorAnnotations()
+            .stream()
+            .filter(excerpt -> excerpt.toString().contains(annotationClass.getCanonicalName()))
+            .findFirst();
+    assertThat(annotationExcerpt).named("property accessor annotations").isNotNull();
+    assertThat(asString(annotationExcerpt.get()))
+            .isEqualTo(String.format("%s%n", annotationString));
   }
 
   private static String asString(Excerpt excerpt) {