field annotations @id, @key, @Rev, @from, @to (#439)

Author: rashtao

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

@@ -660,10 +660,7 @@ public Builder setDeserializer(final ArangoDeserializer deserializer) {
          *
          * @param serialization custom serializer/deserializer
          * @return {@link ArangoDB.Builder}
-         * @deprecated Use {@link com.arangodb.mapping.ArangoJack} instead and register custom serializers and deserializers by implementing {@link com.fasterxml.jackson.databind.JsonSerializer} and {@link com.fasterxml.jackson.databind.JsonDeserializer}.
-         * @see <a href="https://www.arangodb.com/docs/stable/drivers/java-reference-serialization.html#custom-serializer">Reference Documentation</a>
          */
-        @Deprecated
         public Builder serializer(final ArangoSerialization serialization) {
             setSerializer(serialization);
             return this;

src/main/java/com/arangodb/async/ArangoDBAsync.java

@@ -846,10 +846,7 @@ public Builder setDeserializer(final ArangoDeserializer deserializer) {
          *
          * @param serialization custom serializer/deserializer
          * @return {@link ArangoDBAsync.Builder}
-         * @deprecated Use {@link com.arangodb.mapping.ArangoJack} instead and register custom serializers and deserializers by implementing {@link com.fasterxml.jackson.databind.JsonSerializer} and {@link com.fasterxml.jackson.databind.JsonDeserializer}.
-         * @see <a href="https://www.arangodb.com/docs/stable/drivers/java-reference-serialization.html#custom-serializer">Reference Documentation</a>
          */
-        @Deprecated
         public Builder serializer(final ArangoSerialization serialization) {
             setSerializer(serialization);
             return this;

src/main/java/com/arangodb/entity/BaseDocument.java

@@ -20,7 +20,7 @@
 
 package com.arangodb.entity;
 
-import com.arangodb.entity.DocumentField.Type;
+import com.arangodb.internal.DocumentFields;
 
 import java.io.Serializable;
 import java.util.HashMap;
@@ -33,11 +33,11 @@ public class BaseDocument implements Serializable {
 
     private static final long serialVersionUID = -1824742667228719116L;
 
-    @DocumentField(Type.ID)
+    @Id
     protected String id;
-    @DocumentField(Type.KEY)
+    @Key
     protected String key;
-    @DocumentField(Type.REV)
+    @Rev
     protected String revision;
     protected Map<String, Object> properties;
 
@@ -53,15 +53,15 @@ public BaseDocument(final String key) {
 
     public BaseDocument(final Map<String, Object> properties) {
         this();
-        final Object tmpId = properties.remove(DocumentField.Type.ID.getSerializeName());
+        final Object tmpId = properties.remove(DocumentFields.ID);
         if (tmpId != null) {
             id = tmpId.toString();
         }
-        final Object tmpKey = properties.remove(DocumentField.Type.KEY.getSerializeName());
+        final Object tmpKey = properties.remove(DocumentFields.KEY);
         if (tmpKey != null) {
             key = tmpKey.toString();
         }
-        final Object tmpRev = properties.remove(DocumentField.Type.REV.getSerializeName());
+        final Object tmpRev = properties.remove(DocumentFields.REV);
         if (tmpRev != null) {
             revision = tmpRev.toString();
         }

src/main/java/com/arangodb/entity/BaseEdgeDocument.java

@@ -20,7 +20,7 @@
 
 package com.arangodb.entity;
 
-import com.arangodb.entity.DocumentField.Type;
+import com.arangodb.internal.DocumentFields;
 
 import java.util.Map;
 
@@ -31,9 +31,9 @@ public class BaseEdgeDocument extends BaseDocument {
 
     private static final long serialVersionUID = 6904923804449368783L;
 
-    @DocumentField(Type.FROM)
+    @From
     private String from;
-    @DocumentField(Type.TO)
+    @To
     private String to;
 
     public BaseEdgeDocument() {
@@ -54,11 +54,11 @@ public BaseEdgeDocument(final String key, final String from, final String to) {
 
     public BaseEdgeDocument(final Map<String, Object> properties) {
         super(properties);
-        final Object tmpFrom = properties.remove(DocumentField.Type.FROM.getSerializeName());
+        final Object tmpFrom = properties.remove(DocumentFields.FROM);
         if (tmpFrom != null) {
             from = tmpFrom.toString();
         }
-        final Object tmpTo = properties.remove(DocumentField.Type.TO.getSerializeName());
+        final Object tmpTo = properties.remove(DocumentFields.TO);
         if (tmpTo != null) {
             to = tmpTo.toString();
         }

src/main/java/com/arangodb/entity/DocumentEntity.java

@@ -20,18 +20,16 @@
 
 package com.arangodb.entity;
 
-import com.arangodb.entity.DocumentField.Type;
-
 /**
  * @author Mark Vollmary
  */
 public class DocumentEntity implements Entity {
 
-    @DocumentField(Type.KEY)
+    @Key
     private String key;
-    @DocumentField(Type.ID)
+    @Id
     private String id;
-    @DocumentField(Type.REV)
+    @Rev
     private String rev;
 
     public DocumentEntity() {

src/main/java/com/arangodb/entity/DocumentField.java

@@ -27,13 +27,45 @@
 
 /**
  * @author Mark Vollmary
+ * @deprecated Use {@link Id}, {@link Key}, {@link Rev}, {@link From} or {@link To} instead.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.FIELD})
+@Deprecated
 public @interface DocumentField {
 
+    @Deprecated
     enum Type {
-        ID("_id"), KEY("_key"), REV("_rev"), FROM("_from"), TO("_to");
+
+        /**
+         * @deprecated Use {@link Id} instead.
+         */
+        @Deprecated
+        ID("_id"),
+
+        /**
+         * @deprecated Use {@link Key} instead.
+         */
+        @Deprecated
+        KEY("_key"),
+
+        /**
+         * @deprecated Use {@link Rev} instead.
+         */
+        @Deprecated
+        REV("_rev"),
+
+        /**
+         * @deprecated Use {@link From} instead.
+         */
+        @Deprecated
+        FROM("_from"),
+
+        /**
+         * @deprecated Use {@link To} instead.
+         */
+        @Deprecated
+        TO("_to");
 
         private final String serializeName;
 

src/main/java/com/arangodb/entity/From.java

@@ -0,0 +1,23 @@
+package com.arangodb.entity;
+
+import com.arangodb.internal.DocumentFields;
+import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * @author Michele Rastelli
+ */
+// TODO: in v7 add targets ElementType.METHOD and ElementType.PARAMETER
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@JacksonAnnotationsInside
+@JsonProperty(DocumentFields.FROM)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public @interface From {
+}

src/main/java/com/arangodb/entity/Id.java

@@ -0,0 +1,23 @@
+package com.arangodb.entity;
+
+import com.arangodb.internal.DocumentFields;
+import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * @author Michele Rastelli
+ */
+// TODO: in v7 add targets ElementType.METHOD and ElementType.PARAMETER
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@JacksonAnnotationsInside
+@JsonProperty(DocumentFields.ID)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public @interface Id {
+}

src/main/java/com/arangodb/entity/Key.java

@@ -0,0 +1,23 @@
+package com.arangodb.entity;
+
+import com.arangodb.internal.DocumentFields;
+import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * @author Michele Rastelli
+ */
+// TODO: in v7 add targets ElementType.METHOD and ElementType.PARAMETER
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@JacksonAnnotationsInside
+@JsonProperty(DocumentFields.KEY)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public @interface Key {
+}

src/main/java/com/arangodb/entity/Rev.java

@@ -0,0 +1,23 @@
+package com.arangodb.entity;
+
+import com.arangodb.internal.DocumentFields;
+import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * @author Michele Rastelli
+ */
+// TODO: in v7 add targets ElementType.METHOD and ElementType.PARAMETER
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@JacksonAnnotationsInside
+@JsonProperty(DocumentFields.REV)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public @interface Rev {
+}