added javadoc

Author: Mark

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

@@ -24,6 +24,8 @@
 
 /**
  * @author Mark - mark at arangodb.com
+ * 
+ * @see <a href="https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#explain-an-aql-query">API Documentation</a>
  */
 public class AqlExecutionExplainEntity {
 

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

@@ -22,7 +22,10 @@
 
 /**
  * @author Mark - mark at arangodb.com
- *
+ * 
+ * @see <a href=
+ *      "https://docs.arangodb.com/current/HTTP/AqlUserFunctions/index.html#return-registered-aql-user-functions">API
+ *      Documentation</a>
  */
 public class AqlFunctionEntity {
 
@@ -33,20 +36,18 @@ public AqlFunctionEntity() {
 		super();
 	}
 
+	/**
+	 * @return The fully qualified name of the user function
+	 */
 	public String getName() {
 		return name;
 	}
 
-	public void setName(final String name) {
-		this.name = name;
-	}
-
+	/**
+	 * @return A string representation of the function body
+	 */
 	public String getCode() {
 		return code;
 	}
 
-	public void setCode(final String code) {
-		this.code = code;
-	}
-
 }

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

@@ -25,6 +25,7 @@
 /**
  * @author Mark - mark at arangodb.com
  *
+ * @see <a href="https://docs.arangodb.com/current/HTTP/AqlQuery/index.html#parse-an-aql-query">API Documentation</a>
  */
 public class AqlParseEntity {
 

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

@@ -22,7 +22,9 @@
 
 /**
  * @author Mark - mark at arangodb.com
- *
+ * 
+ * @see <a href="https://docs.arangodb.com/current/HTTP/MiscellaneousFunctions/index.html#return-server-version">API
+ *      Documentation</a>
  */
 public class ArangoDBVersion {
 
@@ -33,10 +35,17 @@ public ArangoDBVersion() {
 		super();
 	}
 
+	/**
+	 * @return will always contain arango
+	 */
 	public String getServer() {
 		return server;
 	}
 
+	/**
+	 * @return the server version string. The string has the format "major.minor.sub". major and minor will be numeric,
+	 *         and sub may contain a number or a textual version.
+	 */
 	public String getVersion() {
 		return version;
 	}

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

@@ -23,6 +23,7 @@
 /**
  * @author Mark - mark at arangodb.com
  *
+ * @see <a href="https://docs.arangodb.com/current/HTTP/Collection/Creating.html">API Documentation</a>
  */
 public class CollectionEntity {
 

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

@@ -25,6 +25,8 @@
 /**
  * @author Mark - mark at arangodb.com
  *
+ * @see <a href= "https://docs.arangodb.com/current/HTTP/Collection/Getting.html#read-properties-of-a-collection">API
+ *      Documentation</a>
  */
 public class CollectionPropertiesEntity extends CollectionEntity {
 
@@ -80,6 +82,10 @@ public void setCount(final Long count) {
 		this.count = count;
 	}
 
+	/**
+	 * @return contains the names of document attributes that are used to determine the target shard for documents. Only
+	 *         in a cluster setup
+	 */
 	public Integer getNumberOfShards() {
 		return numberOfShards;
 	}
@@ -88,6 +94,9 @@ public void setNumberOfShards(final Integer numberOfShards) {
 		this.numberOfShards = numberOfShards;
 	}
 
+	/**
+	 * @return the number of shards of the collection. Only in a cluster setup.
+	 */
 	public Collection<String> getShardKeys() {
 		return shardKeys;
 	}

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

@@ -23,6 +23,8 @@
 /**
  * @author Mark - mark at arangodb.com
  *
+ * @see <a href="https://docs.arangodb.com/current/HTTP/Collection/Getting.html#return-collection-revision-id">API
+ *      Documentation</a>
  */
 public class CollectionRevisionEntity extends CollectionEntity {
 

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

@@ -26,10 +26,64 @@
 
 /**
  * @author Mark - mark at arangodb.com
- *
+ * 
+ * @see <a href="https://docs.arangodb.com/current/HTTP/AqlQueryCursor/AccessingCursors.html#create-cursor">API
+ *      Documentation</a>
  */
 public class CursorEntity {
 
+	private String id;
+	private Integer count;
+	private Extras extra;
+	private Boolean cached;
+	private Boolean hasMore;
+	private VPackSlice result;
+
+	public String getId() {
+		return id;
+	}
+
+	/**
+	 * @return the total number of result documents available (only available if the query was executed with the count
+	 *         attribute set)
+	 */
+	public Integer getCount() {
+		return count;
+	}
+
+	/**
+	 * @return an optional object with extra information about the query result contained in its stats sub-attribute.
+	 *         For data-modification queries, the extra.stats sub-attribute will contain the number of modified
+	 *         documents and the number of documents that could not be modified due to an error (if ignoreErrors query
+	 *         option is specified)
+	 */
+	public Extras getExtra() {
+		return extra;
+	}
+
+	/**
+	 * @return a boolean flag indicating whether the query result was served from the query cache or not. If the query
+	 *         result is served from the query cache, the extra return attribute will not contain any stats
+	 *         sub-attribute and no profile sub-attribute.
+	 */
+	public Boolean getCached() {
+		return cached;
+	}
+
+	/**
+	 * @return A boolean indicator whether there are more results available for the cursor on the server
+	 */
+	public Boolean getHasMore() {
+		return hasMore;
+	}
+
+	/**
+	 * @return an vpack-array of result documents (might be empty if query has no results)
+	 */
+	public VPackSlice getResult() {
+		return result;
+	}
+
 	public static class Warning {
 
 		private Integer code;
@@ -53,18 +107,10 @@ public Stats getStats() {
 			return stats;
 		}
 
-		public void setStats(final Stats stats) {
-			this.stats = stats;
-		}
-
 		public Collection<Warning> getWarnings() {
 			return warnings;
 		}
 
-		public void setWarnings(final Collection<Warning> warnings) {
-			this.warnings = warnings;
-		}
-
 	}
 
 	public static class Stats {
@@ -80,113 +126,29 @@ public Long getWritesExecuted() {
 			return writesExecuted;
 		}
 
-		public void setWritesExecuted(final Long writesExecuted) {
-			this.writesExecuted = writesExecuted;
-		}
-
 		public Long getWritesIgnored() {
 			return writesIgnored;
 		}
 
-		public void setWritesIgnored(final Long writesIgnored) {
-			this.writesIgnored = writesIgnored;
-		}
-
 		public Long getScannedFull() {
 			return scannedFull;
 		}
 
-		public void setScannedFull(final Long scannedFull) {
-			this.scannedFull = scannedFull;
-		}
-
 		public Long getScannedIndex() {
 			return scannedIndex;
 		}
 
-		public void setScannedIndex(final Long scannedIndex) {
-			this.scannedIndex = scannedIndex;
-		}
-
 		public Long getFiltered() {
 			return filtered;
 		}
 
-		public void setFiltered(final Long filtered) {
-			this.filtered = filtered;
-		}
-
 		public Long getFullCount() {
 			return fullCount;
 		}
 
-		public void setFullCount(final Long fullCount) {
-			this.fullCount = fullCount;
-		}
-
 		public Double getExecutionTime() {
 			return executionTime;
 		}
 
-		public void setExecutionTime(final Double executionTime) {
-			this.executionTime = executionTime;
-		}
-
-	}
-
-	private String id;
-	private Integer count;
-	private Extras extra;
-	private Boolean cached;
-	private Boolean hasMore;
-	private VPackSlice result;
-
-	public String getId() {
-		return id;
-	}
-
-	public void setId(final String id) {
-		this.id = id;
-	}
-
-	public Integer getCount() {
-		return count;
-	}
-
-	public void setCount(final Integer count) {
-		this.count = count;
 	}
-
-	public Extras getExtra() {
-		return extra;
-	}
-
-	public void setExtra(final Extras extra) {
-		this.extra = extra;
-	}
-
-	public Boolean getCached() {
-		return cached;
-	}
-
-	public void setCached(final Boolean cached) {
-		this.cached = cached;
-	}
-
-	public Boolean getHasMore() {
-		return hasMore;
-	}
-
-	public void setHasMore(final Boolean hasMore) {
-		this.hasMore = hasMore;
-	}
-
-	public VPackSlice getResult() {
-		return result;
-	}
-
-	public void setResult(final VPackSlice result) {
-		this.result = result;
-	}
-
 }

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

@@ -22,7 +22,10 @@
 
 /**
  * @author Mark - mark at arangodb.com
- *
+ * 
+ * @see <a href=
+ *      "https://docs.arangodb.com/current/HTTP/Database/DatabaseManagement.html#information-of-the-database">API
+ *      Documentation</a>
  */
 public class DatabaseEntity {
 
@@ -31,18 +34,30 @@ public class DatabaseEntity {
 	private String path;
 	private Boolean isSystem;
 
+	/**
+	 * @return the id of the database
+	 */
 	public String getId() {
 		return id;
 	}
 
+	/**
+	 * @return the name of the database
+	 */
 	public String getName() {
 		return name;
 	}
 
+	/**
+	 * @return the filesystem path of the database
+	 */
 	public String getPath() {
 		return path;
 	}
 
+	/**
+	 * @return whether or not the database is the _system database
+	 */
 	public Boolean getIsSystem() {
 		return isSystem;
 	}

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

@@ -25,6 +25,8 @@
 /**
  * @author Mark - mark at arangodb.com
  *
+ * @see <a href="https://docs.arangodb.com/current/HTTP/Document/WorkingWithDocuments.html#create-document">API
+ *      Documentation</a>
  */
 public class DocumentCreateEntity<T> extends DocumentEntity {
 
@@ -35,6 +37,9 @@ public DocumentCreateEntity() {
 		super();
 	}
 
+	/**
+	 * @return If the query parameter returnNew is true, then the complete new document is returned.
+	 */
 	public T getNew() {
 		return newDocument;
 	}