8000 some docu · anderick/arangodb-java-driver@3e2517d · GitHub
[go: up one dir, main page]

Skip to content

Commit 3e2517d

Browse files
committed
some docu
1 parent d20044b commit 3e2517d

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

src/main/java/com/arangodb/ArangoDriver.java

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3631,7 +3631,7 @@ public DeletedEntity graphDeleteVertex(String graphName, String collectionName,
36313631
* @param ifNoneMatchRevision
36323632
* If not null the revision of the vertex in the database has to be
36333633
* different to return a document.
3634-
* @return
3634+
* @return DeletedEntity
36353635
* @throws ArangoException
36363636
*/
36373637
public DeletedEntity graphDeleteVertex(
@@ -3656,10 +3656,14 @@ public DeletedEntity graphDeleteVertex(
36563656
* only run successfully if the vertex is contained within the graph.
36573657
*
36583658
* @param graphName
3659+
* The name of the graph.
36593660
* @param collectionName
3661+
* The collection, containing the vertex to replace.
36603662
* @param key
3663+
* The key (document handle) of the vertex to replace.
36613664
* @param vertex
3662-
* @return
3665+
* The object to replace the existing vertex.
3666+
* @return DocumentEntity<T>
36633667
* @throws ArangoException
36643668
*/
36653669
public <T> DocumentEntity<T> graphReplaceVertex(String graphName, String collectionName, String key, Object vertex)
@@ -3672,13 +3676,21 @@ public <T> DocumentEntity<T> graphReplaceVertex(String graphName, String collect
36723676
* only run successfully if the vertex is contained within the graph.
36733677
*
36743678
* @param graphName
3679+
* The name of the graph.
36753680
* @param collectionName
3681+
* The collection, containing the vertex to replace.
36763682
* @param key
3683+
* The key (document handle) of the vertex to replace.
36773684
* @param vertex
3685+
* The object to replace the existing vertex.
36783686
* @param waitForSync
36793687
* Wait for sync.
36803688
* @param ifMatchRevision
3689+
* If not null the revision of the vertex in the database has to be
3690+
* equal to replace the document.
36813691
* @param ifNoneMatchRevision
3692+
* If not null the revision of the vertex in the database has to be
3693+
* different to replace the document.
36823694
* @return
36833695
* @throws ArangoException
36843696
*/
@@ -3706,11 +3718,15 @@ public <T> DocumentEntity<T> graphReplaceVertex(
37063718
* will only run successfully if the vertex is contained within the graph.
37073719
*
37083720
* @param graphName
3721+
* The name of the graph.
37093722
* @param collectionName
3723+
* The collection, containing the vertex to update.
37103724
* @param key
3725+
* The key (document handle) of the vertex to be updated.
37113726
* @param vertex
3727+
* The object to update the existing vertex.
37123728
* @param keepNull
3713-
* @return
3729+
* @return DocumentEntity<T>
37143730
* @throws ArangoException
37153731
*/
37163732
public <T> DocumentEntity<T> graphUpdateVertex(
@@ -3736,15 +3752,23 @@ public <T> DocumentEntity<T> graphUpdateVertex(
37363752
* will only run successfully if the vertex is contained within the graph.
37373753
*
37383754
* @param graphName
3755+
* The name of the graph.
37393756
* @param collectionName
3757+
* The collection, containing the vertex to update.
37403758
* @param key
3759+
* The key (document handle) of the vertex to be updated.
37413760
* @param vertex
3761+
* The object to update the existing vertex.
37423762
* @param keepNull
37433763
* @param waitForSync
37443764
* Wait for sync.
37453765
* @param ifMatchRevision
3766+
* If not null the revision of the vertex in the database has to be
3767+
* equal to update the document.
37463768
* @param ifNoneMatchRevision
3747-
* @return
3769+
* If not null the revision of the vertex in the database has to be
3770+
* different to update the document.
3771+
* @return DocumentEntity<T>
37483772
* @throws ArangoException
37493773
*/
37503774
public <T> DocumentEntity<T> graphUpdateVertex(

0 commit comments

Comments
 (0)
0