added option serializeNull in DocumentUpdateOptions

Author: Mark

ChangeLog

@@ -4,6 +4,7 @@ v4.1.1 (2016-xx-xx)
 * fixed VelocyPack bug with non-ASCII characters
 * added missing replicationFactor in CollectionCreateOptions
 * added missing replicationFactor in CollectionPropertiesEntity
+* added option serializeNull in DocumentUpdateOptions
 
 v4.1.0 (2016-10-28)
 ---------------------------

src/main/java/com/arangodb/internal/InternalArangoCollection.java

@@ -271,7 +271,7 @@ public <T> Request updateDocumentRequest(final String key, final T value, final
 		request.putQueryParam(ArangoDBConstants.RETURN_NEW, params.getReturnNew());
 		request.putQueryParam(ArangoDBConstants.RETURN_OLD, params.getReturnOld());
 		request.putHeaderParam(ArangoDBConstants.IF_MATCH, params.getIfMatch());
-		request.setBody(executor.serialize(value, true));
+		request.setBody(executor.serialize(value, params.getSerializeNull() == null || params.getSerializeNull()));
 		return request;
 	}
 

src/main/java/com/arangodb/model/DocumentUpdateOptions.java

@@ -35,6 +35,7 @@ public class DocumentUpdateOptions {
 	private String ifMatch;
 	private Boolean returnNew;
 	private Boolean returnOld;
+	private Boolean serializeNull;
 
 	public DocumentUpdateOptions() {
 		super();
@@ -146,4 +147,20 @@ public DocumentUpdateOptions returnOld(final Boolean returnOld) {
 		return this;
 	}
 
+	public Boolean getSerializeNull() {
+		return serializeNull;
+	}
+
+	/**
+	 * @param serializeNull
+	 *            By default, or if this is set to true, all fields of the document which have null values are
+	 *            serialized to VelocyPack otherwise they are excluded from serialization. Use this to update single
+	 *            fields from a stored document.
+	 * @return options
+	 */
+	public DocumentUpdateOptions serializeNull(final Boolean serializeNull) {
+		this.serializeNull = serializeNull;
+		return this;
+	}
+
 }

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -22,6 +22,7 @@
 
 import static org.hamcrest.Matchers.anyOf;
 import static org.hamcrest.Matchers.hasItem;
+import static org.hamcrest.Matchers.hasItems;
 import static org.hamcrest.Matchers.instanceOf;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.not;
@@ -364,6 +365,52 @@ public void updateDocumentKeepNullFalse() {
 		assertThat(readResult.getProperties().keySet(), not(hasItem("a")));
 	}
 
+	private static class TestUpdateEntity {
+		@SuppressWarnings("unused")
+		private String a, b;
+	}
+
+	@Test
+	public void updateDocumentSerializeNullTrue() {
+		final TestUpdateEntity doc = new TestUpdateEntity();
+		doc.a = "foo";
+		doc.b = "foo";
+		final DocumentCreateEntity<TestUpdateEntity> createResult = db.collection(COLLECTION_NAME).insertDocument(doc);
+		final TestUpdateEntity patchDoc = new TestUpdateEntity();
+		patchDoc.a = "bar";
+		final DocumentUpdateEntity<TestUpdateEntity> updateResult = db.collection(COLLECTION_NAME)
+				.updateDocument(createResult.getKey(), patchDoc);
+		assertThat(updateResult, is(notNullValue()));
+		assertThat(updateResult.getKey(), is(createResult.getKey()));
+
+		final BaseDocument readResult = db.collection(COLLECTION_NAME).getDocument(createResult.getKey(),
+			BaseDocument.class);
+		assertThat(readResult.getKey(), is(createResult.getKey()));
+		assertThat(readResult.getProperties().keySet(), hasItem("a"));
+		assertThat(readResult.getAttribute("a").toString(), is("bar"));
+	}
+
+	@Test
+	public void updateDocumentSerializeNullFalse() {
+		final TestUpdateEntity doc = new TestUpdateEntity();
+		doc.a = "foo";
+		doc.b = "foo";
+		final DocumentCreateEntity<TestUpdateEntity> createResult = db.collection(COLLECTION_NAME).insertDocument(doc);
+		final TestUpdateEntity patchDoc = new TestUpdateEntity();
+		patchDoc.a = "bar";
+		final DocumentUpdateEntity<TestUpdateEntity> updateResult = db.collection(COLLECTION_NAME)
+				.updateDocument(createResult.getKey(), patchDoc, new DocumentUpdateOptions().serializeNull(false));
+		assertThat(updateResult, is(notNullValue()));
+		assertThat(updateResult.getKey(), is(createResult.getKey()));
+
+		final BaseDocument readResult = db.collection(COLLECTION_NAME).getDocument(createResult.getKey(),
+			BaseDocument.class);
+		assertThat(readResult.getKey(), is(createResult.getKey()));
+		assertThat(readResult.getProperties().keySet(), hasItems("a", "b"));
+		assertThat(readResult.getAttribute("a").toString(), is("bar"));
+		assertThat(readResult.getAttribute("b").toString(), is("foo"));
+	}
+
 	@SuppressWarnings("unchecked")
 	@Test
 	public void updateDocumentMergeObjectsTrue() {