more apidocs and fixed bug in IndexEntity

Author: scottashton

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

@@ -643,8 +643,8 @@ public IndexEntity deserialize(JsonElement json, Type typeOfT, JsonDeserializati
         entity.fields = context.deserialize(obj.getAsJsonArray("fields"), fieldsType);
       }
 
-      if (obj.has("getJson")) {
-        entity.getJson = obj.getAsJsonPrimitive("getJson").getAsBoolean();
+      if (obj.has("geoJson")) {
+        entity.geoJson = obj.getAsJsonPrimitive("geoJson").getAsBoolean();
       }
 
       if (obj.has("isNewlyCreated")) {

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

@@ -19,20 +19,55 @@
 import java.util.List;
 
 /**
+ * An entity representing an index on a collection
+ *
  * @author tamtam180 - kirscheless at gmail.com
  *
  */
 public class IndexEntity extends BaseEntity {
 
+  /**
+   * the index id
+   */
   String id;
+
+  /**
+   * the type of the index
+   * @see com.arangodb.entity.IndexType
+   */
   IndexType type;
+
+  /**
+   * the fields the index is defined on
+   */
   List<String> fields;
-  boolean getJson;
+
+  /**
+   * if the index is a geoIndex and *geoJson* is true, then the order within the list is longitude followed by latitude.
+   * This corresponds to the format described in http://geojson.org/geojson-spec.html#positions
+   */
+  boolean geoJson;
+
+  /**
+   * is a newly created index
+   */
   boolean isNewlyCreated;
+
+  /**
+   * if true the index is a unique index.
+   */
   boolean unique;
+
+  /**
+   * the maximum amount of documents in case the index type is capped
+   */
   int size;
+
+  /**
+   * minimum character length of words to index in case the index type is a fulltext
+   */
   int minLength;
-  
+
   public String getId() {
     return id;
   }
@@ -42,8 +77,8 @@ public IndexType getType() {
   public List<String> getFields() {
     return fields;
   }
-  public boolean isGetJson() {
-    return getJson;
+  public boolean isGeoJson() {
+    return geoJson;
   }
   public boolean isNewlyCreated() {
     return isNewlyCreated;
@@ -63,8 +98,8 @@ public void setType(IndexType type) {
   public void setFields(List<String> fields) {
     this.fields = fields;
   }
-  public void setGetJson(boolean getJson) {
-    this.getJson = getJson;
+  public void setGeoJson(boolean getJson) {
+    this.geoJson = getJson;
   }
   public void setNewlyCreated(boolean isNewlyCreated) {
     this.isNewlyCreated = isNewlyCreated;

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

@@ -20,12 +20,21 @@
 import java.util.Map;
 
 /**
+ * An entity defining an index list
+ *
  * @author tamtam180 - kirscheless at gmail.com
  *
  */
 public class IndexesEntity extends BaseEntity {
 
+  /**
+   * the list of index entites
+   */
   List<IndexEntity> indexes;
+
+  /**
+   * a map containing the indices , there ids as keys.
+   */
   Map<String, IndexEntity> identifiers;
 
   public List<IndexEntity> getIndexes() {

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

@@ -17,10 +17,19 @@
 package com.arangodb.entity;
 
 /**
+ * Enumeration for update/replace policy
+ *
  * @author tamtam180 - kirscheless at gmail.com
  *
  */
 public enum Policy {
+  /**
+   * if ERROR an error is returned when there is a revision mismatch
+   */
   ERROR,
+
+  /**
+   * if LAST the operation is performed even when there is a revision mismatch
+   */
   LAST
 }

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

@@ -17,21 +17,67 @@
 package com.arangodb.entity;
 
 /**
+ * The configuration of the replication applier. The configuration can only be changed while the applier is not running.
+ * The updated configuration will be saved immediately but only become active with the next start of the applier.
+ *
  * @author tamtam180 - kirscheless at gmail.com
  *
  */
 public class ReplicationApplierConfigEntity extends BaseEntity {
 
+  /**
+   * the logger server to connect to (e.g. "tcp://192.168.173.13:8529"). The endpoint must be specified.
+   */
   String endpoint;
+
+  /**
+   * the name of the database on the endpoint. If not specified, defaults to the current local database name.
+   */
   String database;
+
+  /**
+   * an optional ArangoDB username to use when connecting to the endpoint.
+   */
   String username;
+
+  /**
+   * the password to use when connecting to the endpoint.
+   */
   String password;
+
+  /**
+   * the maximum number of connection attempts the applier will make in a row. If the applier cannot establish a
+   * connection to the endpoint in this number of attempts, it will stop itself.
+   */
   Integer maxConnectRetries;
+
+  /**
+   * the timeout (in seconds) when attempting to connect to the endpoint. This value is used for each connection attempt.
+   */
   Integer connectTimeout;
+
+  /**
+   * the timeout (in seconds) for individual requests to the endpoint.
+   */
   Integer requestTimeout;
+
+  /**
+   * the requested maximum size for log transfer packets that is used when the endpoint is contacted.
+   */
   Integer chunkSize;
+
+  /**
+   * whether or not to auto-start the replication applier on (next and following) server starts
+   */
   Boolean autoStart;
+
+  /**
+   * if set to true, the replication applier will fall to sleep for an increasingly long period in case the logger
+   * server at the endpoint does not have any more replication events to apply.
+   */
   Boolean adaptivePolling;
+
+
 
   public String getEndpoint() {
     return endpoint;

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

@@ -20,26 +20,80 @@
 import java.util.Date;
 
 /**
+ * the state of the replication applier, regardless of whether the applier is currently running or not.
+ *
  * @author tamtam180 - kirscheless at gmail.com
  *
  */
 public class ReplicationApplierState implements Serializable {
 
+  /**
+   * whether or not the applier is active and running
+   */
   Boolean running;
+
+  /**
+   * the last tick value from the continuous replication log the applier has applied
+   */
   Long lastAppliedContinuousTick;
+
+  /**
+   * the last tick value from the continuous replication log the applier has processed.
+   */
   Long lastProcessedContinuousTick;
+
+  /**
+   * the last tick value the logger server can provide.
+   */
   Long lastAvailableContinuousTick;
+
+  /**
+   * the time on the applier server.
+   */
   Date time;
+
+  /**
+   * the total number of requests the applier has made to the endpoint.
+   */
   Long totalRequests;
+
+  /**
+   * the total number of failed connection attempts the applier has made.
+   */
   Long totalFailedConnects;
+
+  /**
+   * the total number of log events the applier has processed.
+   */
   Long totalEvents;
+
+  /**
+   * details about the last error that happened on the applier.
+   */
   LastError lastError;
+
+  /**
+   * details about the replication applier progress.
+   * @see com.arangodb.entity.ReplicationApplierState.Progress
+   */
   Progress progress;
 
   public static class Progress implements Serializable {
+    /**
+     * the date and time the progress was logged
+     */
     Date time;
+
+    /**
+     * a textual description of the progress
+     */
     String message;
+
+    /**
+     * the current number of failed connection attempts
+     */
     Long failedConnects;
+
     public Date getTime() {
       return time;
     }
@@ -61,9 +115,21 @@ public void setFailedConnects(Long failedConnects) {
   }
 
   public static class LastError implements Serializable {
+    /**
+     * the date and time the error occurred In case no error has occurred, lastError will be empty.
+     */
     Date time;
+
+    /**
+     * a textual error description
+     */
     String errorMessage;
+
+    /**
+     * a numerical error code
+     */
     Integer errorNum;
+
     public Date getTime() {
       return time;
     }

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

@@ -17,15 +17,37 @@
 package com.arangodb.entity;
 
 /**
+ * An entity representing a ReplicationApplierState
+ *
  * @author tamtam180 - kirscheless at gmail.com
  *
  */
 public class ReplicationApplierStateEntity extends BaseEntity {
 
+  /**
+   * The applier state
+   * @see com.arangodb.entity.ReplicationApplierState
+   */
   ReplicationApplierState state;
+
+  /**
+   * The version of the server
+   */
   String serverVersion;
+
+  /**
+   * The server id
+   */
   String serverId;
+
+  /**
+   * The endpoint
+   */
   String endpoint;
+
+  /**
+   * The database
+   */
   String database;
 
   public ReplicationApplierState getState() {

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

@@ -19,6 +19,8 @@
 import java.io.Serializable;
 
 /**
+ *
+ *
  * @author tamtam180 - kirscheless at gmail.com
  *
  */