added some javadoc

Author: Mark

src/main/java/com/arangodb/ArangoCursor.java

@@ -61,6 +61,9 @@ public ArangoCursor(final InternalArangoDatabase<?, ?, ?> db, final ArangoCursor
 		id = result.getId();
 	}
 
+	/**
+	 * @return id of temporary cursor created on the server
+	 */
 	public String getId() {
 		return id;
 	}
@@ -69,6 +72,10 @@ public Class<T> getType() {
 		return type;
 	}
 
+	/**
+	 * @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;
 	}
@@ -81,6 +88,9 @@ public Collection<Warning> getWarnings() {
 		return extra != null ? extra.getWarnings() : null;
 	}
 
+	/**
+	 * @return indicating whether the query result was served from the query cache or not
+	 */
 	public boolean isCached() {
 		return cached;
 	}

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

@@ -31,12 +31,12 @@
 import com.arangodb.entity.LogEntity;
 import com.arangodb.entity.UserEntity;
 import com.arangodb.internal.ArangoDBConstants;
-import com.arangodb.internal.InternalArangoDB;
 import com.arangodb.internal.ArangoExecutor.ResponseDeserializer;
 import com.arangodb.internal.ArangoExecutorSync;
 import com.arangodb.internal.CollectionCache;
 import com.arangodb.internal.CollectionCache.DBAccess;
 import com.arangodb.internal.DocumentCache;
+import com.arangodb.internal.InternalArangoDB;
 import com.arangodb.internal.velocypack.VPackConfigure;
 import com.arangodb.internal.velocystream.Communication;
 import com.arangodb.internal.velocystream.CommunicationSync;
@@ -209,10 +209,22 @@ public void shutdown() {
 		executor.communication().disconnect();
 	}
 
+	/**
+	 * Returns a handler of the system database
+	 * 
+	 * @return database handler
+	 */
 	public ArangoDatabase db() {
 		return db(ArangoDBConstants.SYSTEM);
 	}
 
+	/**
+	 * Returns a handler of the database by the given name
+	 * 
+	 * @param name
+	 *            Name of the database
+	 * @return database handler
+	 */
 	public ArangoDatabase db(final String name) {
 		return new ArangoDatabase(this, name);
 	}
@@ -371,7 +383,15 @@ public UserEntity replaceUser(final String user, final UserUpdateOptions options
 		return executor.execute(replaceUserRequest(db().name(), user, options), UserEntity.class);
 	}
 
-	public Response execute(final Request request) {
+	/**
+	 * Generic Execute. Use this method to execute custom FOXX services.
+	 * 
+	 * @param request
+	 *            VelocyStream request
+	 * @return VelocyStream response
+	 * @throws ArangoDBException
+	 */
+	public Response execute(final Request request) throws ArangoDBException {
 		return executor.execute(request, new ResponseDeserializer<Response>() {
 			@Override
 			public Response deserialize(final Response response) throws VPackException {

src/main/java/com/arangodb/ArangoDatabase.java

@@ -37,10 +37,10 @@
 import com.arangodb.entity.QueryTrackingPropertiesEntity;
 import com.arangodb.entity.TraversalEntity;
 import com.arangodb.internal.ArangoCursorExecute;
-import com.arangodb.internal.InternalArangoDatabase;
 import com.arangodb.internal.ArangoExecutorSync;
 import com.arangodb.internal.CollectionCache;
 import com.arangodb.internal.DocumentCache;
+import com.arangodb.internal.InternalArangoDatabase;
 import com.arangodb.internal.velocystream.Communication;
 import com.arangodb.internal.velocystream.ConnectionSync;
 import com.arangodb.model.AqlFunctionCreateOptions;
@@ -81,6 +81,13 @@ protected ArangoExecutorSync executor() {
 		return executor;
 	}
 
+	/**
+	 * Returns a handler of the collection by the given name
+	 * 
+	 * @param name
+	 *            Name of the collection
+	 * @return collection handler
+	 */
 	public ArangoCollection collection(final String name) {
 		return new ArangoCollection(this, name);
 	}
@@ -233,10 +240,12 @@ public <T> ArangoCursor<T> query(
 		final Request request = queryRequest(query, bindVars, options);
 		final CursorEntity result = executor.execute(request, CursorEntity.class);
 		return new ArangoCursor<T>(this, new ArangoCursorExecute() {
+			@Override
 			public CursorEntity next(final String id) {
 				return executor.execute(queryNextRequest(id), CursorEntity.class);
 			}
 
+			@Override
 			public void close(final String id) {
 				executor.execute(queryCloseRequest(id), Void.class);
 			}
@@ -453,6 +462,13 @@ public Collection<AqlFunctionEntity> getAqlFunctions(final AqlFunctionGetOptions
 		}.getType());
 	}
 
+	/**
+	 * Returns a handler of the graph by the given name
+	 * 
+	 * @param name
+	 *            Name of the graph
+	 * @return graph handler
+	 */
 	public ArangoGraph graph(final String name) {
 		return new ArangoGraph(this, name);
 	}

src/main/java/com/arangodb/ArangoGraph.java

@@ -91,10 +91,24 @@ public GraphEntity addVertexCollection(final String name) throws ArangoDBExcepti
 		return executor.execute(addVertexCollectionRequest(name), addVertexCollectionResponseDeserializer());
 	}
 
+	/**
+	 * Returns a handler of the vertex collection by the given name
+	 * 
+	 * @param name
+	 *            Name of the vertex collection
+	 * @return collection handler
+	 */
 	public ArangoVertexCollection vertexCollection(final String name) {
 		return new ArangoVertexCollection(this, name);
 	}
 
+	/**
+	 * Returns a handler of the edge collection by the given name
+	 * 
+	 * @param name
+	 *            Name of the edge collection
+	 * @return collection handler
+	 */
 	public ArangoEdgeCollection edgeCollection(final String name) {
 		return new ArangoEdgeCollection(this, name);
 	}