added extension point for VelocyPack serialization

Author: mpv1989

ChangeLog

@@ -5,6 +5,7 @@ v4.1.11 (2017-03-xx)
 * fixed exception handling in Connection (issue #110)
 * added connection pooling (issue #103)
 * extracted VelocyPack implementation to https://github.com/arangodb/java-velocypack
+* added extension point for VelocyPack serialization (ArangoDB.registerModule())
 * fixed NPE in ArangoCursor (issue #112)
 * added support for replacing build-in VelocyPack serializer/deserializer
 * added ArangoDatabase.getVersion(), ArangoDatabase.getAccessibleDatabases()

README.md

@@ -54,6 +54,57 @@ If you want to test with a snapshot version (e.g. 4.0.0-SNAPSHOT), add the stagi
 mvn clean install -DskipTests=true -Dgpg.skip=true -Dmaven.javadoc.skip=true -B
 ```	
 
+## configure VelocyPack serialization
+
+Since version `4.1.11` you can extend the VelocyPack serialization by registering additional `VPackModule`s on `ArangoDB.Builder`.
+
+### Java 8 types 
+
+Added support for:
+* java.time.Instant
+* java.time.LocalDate
+* java.time.LocalDateTime
+* java.util.Optional;
+* java.util.OptionalDouble;
+* java.util.OptionalInt;
+* java.util.OptionalLong;
+
+```XML
+<dependencies>
+  <dependency>
+    <groupId>com.arangodb</groupId>
+    <artifactId>velocypack-module-jdk8</artifactId>
+    <version>1.0.1</version>
+  </dependency>
+</dependencies>
+```
+
+``` Java
+ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackJdk8Module()).build();
+``` 
+
+### Joda-Time
+
+Added support for:
+* org.joda.time.DateTime;
+* org.joda.time.Instant;
+* org.joda.time.LocalDate;
+* org.joda.time.LocalDateTime;
+
+```XML
+<dependencies>
+  <dependency>
+    <groupId>com.arangodb</groupId>
+    <artifactId>velocypack-module-joda</artifactId>
+    <version>1.0.0</version>
+  </dependency>
+</dependencies>
+```
+
+``` Java
+ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackJodaModule()).build();
+``` 
+
 # Learn more
 * [ArangoDB](https://www.arangodb.com/)
 * [ChangeLog](ChangeLog)

pom.xml

@@ -27,7 +27,7 @@
 		<logback-classic.version>1.1.3</logback-classic.version>
 		<hamcrest-all.version>1.3</hamcrest-all.version>
 		<junit.version>4.12</junit.version>
-		<arangodb.velocypack.version>1.0.1</arangodb.velocypack.version>
+		<arangodb.velocypack.version>1.0.2</arangodb.velocypack.version>
 	</properties>
 
 	<developers>

src/main/java/com/arangodb/ArangoDB.java

@@ -65,6 +65,7 @@
 import com.arangodb.velocypack.VPackJsonSerializer;
 import com.arangodb.velocypack.VPackModule;
 import com.arangodb.velocypack.VPackParser;
+import com.arangodb.velocypack.VPackParserModule;
 import com.arangodb.velocypack.VPackSerializer;
 import com.arangodb.velocypack.ValueType;
 import com.arangodb.velocypack.exception.VPackException;
@@ -280,11 +281,41 @@ public Builder registerModules(final VPackModule... modules) {
 			return this;
 		}
 
+		public Builder registerJsonModule(final VPackParserModule module) {
+			vpackParserBuilder.registerModule(module);
+			return this;
+		}
+
+		public Builder registerJsonModules(final VPackParserModule... module) {
+			vpackParserBuilder.registerModules(module);
+			return this;
+		}
+
+		/**
+		 * Replace the built-in serializer with the given serializer.
+		 * 
+		 * <br />
+		 * <b>ATTENTION!:</b> Use at your own risk
+		 * 
+		 * @param serializer
+		 *            custom serializer
+		 * @return builder
+		 */
 		public Builder setSerializer(final ArangoSerializer serializer) {
 			this.serializer = serializer;
 			return this;
 		}
 
+		/**
+		 * Replace the built-in deserializer with the given deserializer.
+		 * 
+		 * <br />
+		 * <b>ATTENTION!:</b> Use at your own risk
+		 * 
+		 * @param deserializer
+		 *            custom deserializer
+		 * @return builder
+		 */
 		public Builder setDeserializer(final ArangoDeserializer deserializer) {
 			this.deserializer = deserializer;
 			return this;