Skip to content

Commit 414645c

Browse files
author
Mark
committed
added some javadoc
1 parent 8220fc0 commit 414645c

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,10 +219,22 @@ public void shutdown() {
219219
executor.communication().disconnect();
220220
}
221221

222+
/**
223+
* Returns a handler of the system database
224+
*
225+
* @return database handler
226+
*/
222227
public ArangoDatabaseAsync db() {
223228
return db(ArangoDBConstants.SYSTEM);
224229
}
225230

231+
/**
232+
* Returns a handler of the database by the given name
233+
*
234+
* @param name
235+
* Name of the database
236+
* @return database handler
237+
*/
226238
public ArangoDatabaseAsync db(final String name) {
227239
return new ArangoDatabaseAsync(this, name);
228240
}
@@ -373,6 +385,14 @@ public CompletableFuture<UserEntity> replaceUser(final String user, final UserUp
373385
return executor.execute(replaceUserRequest(db().name(), user, options), UserEntity.class);
374386
}
375387

388+
/**
389+
* Generic Execute. Use this method to execute custom FOXX services.
390+
*
391+
* @param request
392+
* VelocyStream request
393+
* @return VelocyStream response
394+
* @throws ArangoDBException
395+
*/
376396
public CompletableFuture<Response> execute(final Request request) {
377397
return executor.execute(request, response -> response);
378398
}

src/main/java/com/arangodb/ArangoDatabaseAsync.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,13 @@ protected ArangoExecutorAsync executor() {
8484
return executor;
8585
}
8686

87+
/**
88+
* Returns a handler of the collection by the given name
89+
*
90+
* @param name
91+
* Name of the collection
92+
* @return collection handler
93+
*/
8794
public ArangoCollectionAsync collection(final String name) {
8895
return new ArangoCollectionAsync(this, name);
8996
}
@@ -459,6 +466,13 @@ public CompletableFuture<Collection<AqlFunctionEntity>> getAqlFunctions(final Aq
459466
}.getType());
460467
}
461468

469+
/**
470+
* Returns a handler of the graph by the given name
471+
*
472+
* @param name
473+
* Name of the graph
474+
* @return graph handler
475+
*/
462476
public ArangoGraphAsync graph(final String name) {
463477
return new ArangoGraphAsync(this, name);
464478
}

src/main/java/com/arangodb/ArangoGraphAsync.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,24 @@ public CompletableFuture<GraphEntity> addVertexCollection(final String name) {
9090
return executor.execute(addVertexCollectionRequest(name), addVertexCollectionResponseDeserializer());
9191
}
9292

93+
/**
94+
* Returns a handler of the vertex collection by the given name
95+
*
96+
* @param name
97+
* Name of the vertex collection
98+
* @return collection handler
99+
*/
93100
public ArangoVertexCollectionAsync vertexCollection(final String name) {
94101
return new ArangoVertexCollectionAsync(this, name);
95102
}
96103

104+
/**
105+
* Returns a handler of the edge collection by the given name
106+
*
107+
* @param name
108+
* Name of the edge collection
109+
* @return collection handler
110+
*/
97111
public ArangoEdgeCollectionAsync edgeCollection(final String name) {
98112
return new ArangoEdgeCollectionAsync(this, name);
99113
}

0 commit comments

Comments
 (0)