add builder() for protobuf mapper

cowtowncoder · cowtowncoder · commit 2434a63e273b · 2018-06-26T13:42:08.000-07:00
diff --git a/avro/src/main/java/com/fasterxml/jackson/dataformat/avro/AvroMapper.java b/avro/src/main/java/com/fasterxml/jackson/dataformat/avro/AvroMapper.java
@@ -13,7 +13,6 @@
 import com.fasterxml.jackson.databind.Module;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.cfg.MapperBuilder;
-import com.fasterxml.jackson.dataformat.avro.AvroMapper.Builder;
 import com.fasterxml.jackson.dataformat.avro.schema.AvroSchemaGenerator;
 
 /**
diff --git a/protobuf/src/main/java/com/fasterxml/jackson/dataformat/protobuf/ProtobufMapper.java b/protobuf/src/main/java/com/fasterxml/jackson/dataformat/protobuf/ProtobufMapper.java
@@ -6,9 +6,12 @@
 import java.net.URL;
 
 import com.fasterxml.jackson.core.Version;
+
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.cfg.MapperBuilder;
+import com.fasterxml.jackson.dataformat.protobuf.ProtobufMapper.Builder;
 import com.fasterxml.jackson.dataformat.protobuf.schema.DescriptorLoader;
 import com.fasterxml.jackson.dataformat.protobuf.schema.FileDescriptorSet;
 import com.fasterxml.jackson.dataformat.protobuf.schema.ProtobufSchema;
@@ -19,6 +22,19 @@ public class ProtobufMapper extends ObjectMapper
 {
     private static final long serialVersionUID = 1L;
 
+    /**
+     * Base implementation for "Vanilla" {@link ObjectMapper}, used with
+     * Protobuf backend.
+     *
+     * @since 2.10
+     */
+    public static class Builder extends MapperBuilder<ProtobufMapper, Builder>
+    {
+        public Builder(ProtobufMapper m) {
+            super(m);
+        }
+    }
+
     protected ProtobufSchemaLoader _schemaLoader = ProtobufSchemaLoader.std;
 
     /**
@@ -46,7 +62,22 @@ public ProtobufMapper(ProtobufFactory f) {
     protected ProtobufMapper(ProtobufMapper src) {
         super(src);
     }
-    
+
+    /**
+     * @since 2.10
+     */
+    @SuppressWarnings("unchecked")
+    public static ProtobufMapper.Builder builder() {
+        return new Builder(new ProtobufMapper());
+    }
+
+    /**
+     * @since 2.10
+     */
+    public static Builder builder(ProtobufFactory streamFactory) {
+        return new Builder(new ProtobufMapper(streamFactory));
+    }
+
     @Override
     public ProtobufMapper copy()
     {
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/EnumHandlingTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/EnumHandlingTest.java
@@ -35,7 +35,7 @@ static class BigEnumWrapper {
     /**********************************************************
      */
 
-    final ProtobufMapper MAPPER = new ProtobufMapper();
+    final ProtobufMapper MAPPER = newObjectMapper();
 
     public void testBigEnum() throws Exception
     {
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ProtobufTestBase.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ProtobufTestBase.java
@@ -453,7 +453,17 @@ && _equals(copyright, other.copyright)
                     ;
         }
     }
-    
+
+    /*
+    /**********************************************************
+    /* Factory methods
+    /**********************************************************
+     */
+
+    protected ProtobufMapper newObjectMapper() {
+        return ProtobufMapper.builder().build();
+    }
+
     /*
     /**********************************************************
     /* Additional assertion methods
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ReadPackedRepeatedTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ReadPackedRepeatedTest.java
@@ -7,19 +7,18 @@
 
 public class ReadPackedRepeatedTest extends ProtobufTestBase
 {
-    final ProtobufMapper MAPPER = new ProtobufMapper();
-
     public void testPacked() throws Exception
     {
+        final ProtobufMapper mapper = newObjectMapper();
         final String SCHEMA_STR =
             "package mypackage;\n"
             + "message t {\n"
             + "        repeated uint32 f = 1 [packed=true];\n"
             + "}";
         final byte[] pb = {0xa, 0x3, 0x64, (byte)0xc8, 0x1}; // f = [100, 200]
 
-        ProtobufSchema schema = MAPPER.schemaLoader().load(new StringReader(SCHEMA_STR));
-        JsonNode t = MAPPER.readerFor(JsonNode.class).with(schema).readValue(pb);
+        ProtobufSchema schema = mapper.schemaLoader().load(new StringReader(SCHEMA_STR));
+        JsonNode t = mapper.readerFor(JsonNode.class).with(schema).readValue(pb);
 
         assertEquals(2, t.get("f").size());
         assertEquals(100, t.get("f").get(0).asInt());
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ReadSimpleTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ReadSimpleTest.java
@@ -55,7 +55,7 @@ public NamedStrings(String n, String... v) {
     /**********************************************************
      */
 
-    final ObjectMapper MAPPER = new ProtobufMapper();
+    final ObjectMapper MAPPER = newObjectMapper();
 
     public void testReadPointInt() throws Exception
     {
@@ -340,12 +340,11 @@ public void testSearchMessage() throws Exception
 
     public void testSkipUnknown() throws Exception
     {
-        // Important: write Point3, read regular Point
-        ProtobufMapper mapper = new ProtobufMapper();
-
         ProtobufSchema pointSchema = ProtobufSchemaLoader.std.parse(PROTOC_POINT);
         ProtobufSchema point3Schema = ProtobufSchemaLoader.std.parse(PROTOC_POINT3);
 
+        // Important: write Point3, read regular Point
+        ProtobufMapper mapper = newObjectMapper();
         mapper.enable(JsonParser.Feature.IGNORE_UNDEFINED);
         
         final Point3 input = new Point3(1, 2, 3);
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ReadUnkownFieldsTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/ReadUnkownFieldsTest.java
@@ -64,21 +64,21 @@ public void setF3(int f3) {
     /**********************************************************
      */
 
-    final ProtobufMapper MAPPER = new ProtobufMapper();
-
     public void testMultipleUnknown() throws Exception
     {
+        final ProtobufMapper mapper = newObjectMapper();
+
         ThreeField threeField = new ThreeField();
         threeField.setF1(1);
         threeField.setF2(2);
         threeField.setF3(3);
 
-        ProtobufSchema schemaWith3 = MAPPER.generateSchemaFor(ThreeField.class);
-        byte[] in = MAPPER.writer(schemaWith3)
+        ProtobufSchema schemaWith3 = mapper.generateSchemaFor(ThreeField.class);
+        byte[] in = mapper.writer(schemaWith3)
                 .writeValueAsBytes(threeField);
 
-        ProtobufSchema schemaWith1 = MAPPER.generateSchemaFor(OneField.class);
-        OneField oneField = MAPPER.readerFor(OneField.class).with(schemaWith1)
+        ProtobufSchema schemaWith1 = mapper.generateSchemaFor(OneField.class);
+        OneField oneField = mapper.readerFor(OneField.class).with(schemaWith1)
                 // important: skip through unknown
                 .with(JsonParser.Feature.IGNORE_UNDEFINED)
                 .readValue(in);
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WriteAsMapTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WriteAsMapTest.java
@@ -32,7 +32,7 @@ public class WriteAsMapTest extends ProtobufTestBase
 
     public void testWriteAsMap() throws Exception
     {
-        ObjectMapper mapper = new ProtobufMapper();
+        ObjectMapper mapper = newObjectMapper();
 
         NativeProtobufSchema fileSchema = ProtobufSchemaLoader.std.parseNative(PROTOC);
         ProtobufSchema schema = fileSchema.forType("Person");
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WriteBinaryTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WriteBinaryTest.java
@@ -33,7 +33,7 @@ public Binary(int id, byte[] data, int trailer) {
     /**********************************************************
      */
 
-    private final ObjectMapper MAPPER = new ProtobufMapper();
+    private final ObjectMapper MAPPER = newObjectMapper();
 
     public void testSimpleBinary() throws Exception
     {
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WriteLongString94Test.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WriteLongString94Test.java
@@ -18,7 +18,7 @@ public static class TwoStrings {
     /**********************************************************
      */
 
-    final ProtobufMapper MAPPER = new ProtobufMapper();
+    final ProtobufMapper MAPPER = newObjectMapper();
 
     // [dataformats-binary#94]
     public void testLongerStrings() throws Exception {
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WritePrimitiveArrayTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/WritePrimitiveArrayTest.java
@@ -116,16 +116,14 @@ public StringArray(String... v) {
         }
     }
 
-    final ObjectMapper MAPPER = new ProtobufMapper();
-
-    public WritePrimitiveArrayTest() throws Exception { }
-
     /*
     /**********************************************************
     /* Test methods, int arrays
     /**********************************************************
      */
 
+    final ObjectMapper MAPPER = newObjectMapper();
+    
     public void testVIntArraySparse() throws Exception
     {
         final ObjectWriter w = MAPPER.writer(ProtobufSchemaLoader.std.parse(PROTOC_INT_ARRAY_SPARSE));
diff --git a/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/schema/SchemaGenTest.java b/protobuf/src/test/java/com/fasterxml/jackson/dataformat/protobuf/schema/SchemaGenTest.java
@@ -8,8 +8,6 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-
 import com.fasterxml.jackson.dataformat.protobuf.ProtobufMapper;
 import com.fasterxml.jackson.dataformat.protobuf.ProtobufTestBase;
 import com.fasterxml.jackson.dataformat.protobuf.schema.ProtobufMessage;
@@ -74,7 +72,7 @@ public static class Employee {
     /**********************************************************
      */
 
-	private final ProtobufMapper MAPPER = new ProtobufMapper();
+	private final ProtobufMapper MAPPER = newObjectMapper();
 
 	public void testWithNestedClass() throws Exception
 	{
@@ -101,10 +99,9 @@ public void testWithIndexAnnotation() throws Exception
 	}
 
 	public void testSelfRefPojoGenProtobufSchema() throws Exception {
-	    ProtobufMapper mapper = new ProtobufMapper();
 		ProtobufSchemaGenerator gen = new ProtobufSchemaGenerator();
-		mapper.acceptJsonFormatVisitor(Employee.class, gen);
-		ProtobufSchema schemaWrapper = mapper.generateSchemaFor(Employee.class);
+		MAPPER.acceptJsonFormatVisitor(Employee.class, gen);
+		ProtobufSchema schemaWrapper = MAPPER.generateSchemaFor(Employee.class);
 
 		assertNotNull(schemaWrapper);
 
@@ -117,10 +114,10 @@ public void testSelfRefPojoGenProtobufSchema() throws Exception {
 
 		Employee empl = buildEmployee();
 
-		byte[] byteMsg = mapper.writer(schemaWrapper).writeValueAsBytes(empl);
+		byte[] byteMsg = MAPPER.writer(schemaWrapper).writeValueAsBytes(empl);
 		// System.out.println(byteMsg);
 		ProtobufSchema schema = ProtobufSchemaLoader.std.parse(protoFile);
-		Employee newEmpl = mapper.readerFor(Employee.class).with(schema).readValue(byteMsg);
+		Employee newEmpl = MAPPER.readerFor(Employee.class).with(schema).readValue(byteMsg);
 
 		// System.out.println(newEmpl);
 		assertEquals(empl.name, newEmpl.name);
@@ -130,9 +127,8 @@ public void testSelfRefPojoGenProtobufSchema() throws Exception {
 	}
 
 	public void testComplexPojoGenProtobufSchema() throws Exception {
-		ObjectMapper mapper = new ProtobufMapper();
 		ProtobufSchemaGenerator gen = new ProtobufSchemaGenerator();
-		mapper.acceptJsonFormatVisitor(MediaItem.class, gen);
+		MAPPER.acceptJsonFormatVisitor(MediaItem.class, gen);
 		ProtobufSchema schemaWrapper = gen.getGeneratedSchema();
 		assertNotNull(schemaWrapper);
 
@@ -141,19 +137,18 @@ public void testComplexPojoGenProtobufSchema() throws Exception {
 
 		MediaItem mediaItem = MediaItem.buildItem();
 
-		byte[] byteMsg = mapper.writerFor(MediaItem.class).with(schemaWrapper).writeValueAsBytes(mediaItem);
+		byte[] byteMsg = MAPPER.writerFor(MediaItem.class).with(schemaWrapper).writeValueAsBytes(mediaItem);
 		// System.out.println(byteMsg);
 		ProtobufSchema schema = ProtobufSchemaLoader.std.parse(protoFile);
-		MediaItem deserMediaItem = mapper.readerFor(MediaItem.class).with(schema).readValue(byteMsg);
+		MediaItem deserMediaItem = MAPPER.readerFor(MediaItem.class).with(schema).readValue(byteMsg);
 
 		// System.out.println(deserMediaItem);
 		assertEquals(mediaItem, deserMediaItem);
 	}
 
 	public void testSimplePojoGenProtobufSchema() throws Exception {
-		ObjectMapper mapper = new ProtobufMapper();
 		ProtobufSchemaGenerator gen = new ProtobufSchemaGenerator();
-		mapper.acceptJsonFormatVisitor(RootType.class, gen);
+		MAPPER.acceptJsonFormatVisitor(RootType.class, gen);
 		ProtobufSchema schemaWrapper = gen.getGeneratedSchema();
 
 		assertNotNull(schemaWrapper);
@@ -163,10 +158,10 @@ public void testSimplePojoGenProtobufSchema() throws Exception {
 
 		RootType rType = buildRootType();
 
-		byte[] msg = mapper.writerFor(RootType.class).with(schemaWrapper).writeValueAsBytes(rType);
+		byte[] msg = MAPPER.writerFor(RootType.class).with(schemaWrapper).writeValueAsBytes(rType);
 		// System.out.println(msg);
 		ProtobufSchema schema = ProtobufSchemaLoader.std.parse(protoFile);
-		RootType parsedRootType = mapper.readerFor(RootType.class).with(schema).readValue(msg);
+		RootType parsedRootType = MAPPER.readerFor(RootType.class).with(schema).readValue(msg);
 
 		// System.out.println(parsedRootType);
 		assertEquals(rType.name, parsedRootType.name);

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ static class BigEnumWrapper {`
`35`	`35`	`/**********************************************************`
`36`	`36`	`*/`
`37`	`37`
`38`		`- final ProtobufMapper MAPPER = new ProtobufMapper();`
	`38`	`+ final ProtobufMapper MAPPER = newObjectMapper();`
`39`	`39`
`40`	`40`	`public void testBigEnum() throws Exception`
`41`	`41`	`{`
Original file line number	Diff line number	Diff line change
`@@ -453,7 +453,17 @@ && _equals(copyright, other.copyright)`
`453`	`453`	`;`
`454`	`454`	`}`
`455`	`455`	`}`
`456`		`-`
	`456`	`+`
	`457`	`+ /*`
	`458`	`+ /**********************************************************`
	`459`	`+ /* Factory methods`
	`460`	`+ /**********************************************************`
	`461`	`+ */`
	`462`	`+`
	`463`	`+ protected ProtobufMapper newObjectMapper() {`
	`464`	`+ return ProtobufMapper.builder().build();`
	`465`	`+ }`
	`466`	`+`
`457`	`467`	`/*`
`458`	`468`	`/**********************************************************`
`459`	`469`	`/* Additional assertion methods`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public class WriteAsMapTest extends ProtobufTestBase`
`32`	`32`
`33`	`33`	`public void testWriteAsMap() throws Exception`
`34`	`34`	`{`
`35`		`- ObjectMapper mapper = new ProtobufMapper();`
	`35`	`+ ObjectMapper mapper = newObjectMapper();`
`36`	`36`
`37`	`37`	`NativeProtobufSchema fileSchema = ProtobufSchemaLoader.std.parseNative(PROTOC);`
`38`	`38`	`ProtobufSchema schema = fileSchema.forType("Person");`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public Binary(int id, byte[] data, int trailer) {`
`33`	`33`	`/**********************************************************`
`34`	`34`	`*/`
`35`	`35`
`36`		`- private final ObjectMapper MAPPER = new ProtobufMapper();`
	`36`	`+ private final ObjectMapper MAPPER = newObjectMapper();`
`37`	`37`
`38`	`38`	`public void testSimpleBinary() throws Exception`
`39`	`39`	`{`