align Graph API naming to documentation (DE-729)

Author: rashtao

core/src/main/java/com/arangodb/ArangoEdgeCollection.java

@@ -55,7 +55,10 @@ public interface ArangoEdgeCollection extends ArangoSerdeAccessor {
      * @see <a href=
      * "https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-an-edge-definition-from-the-graph">API
      * Documentation</a>
+     *
+     * @deprecated use {@link #remove()} instead
      */
+    @Deprecated
     void drop();
 
     /**
@@ -65,9 +68,31 @@ public interface ArangoEdgeCollection extends ArangoSerdeAccessor {
      * @see <a href=
      * "https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-an-edge-definition-from-the-graph">API
      * Documentation</a>
+     *
+     * @deprecated use {@link #remove(EdgeCollectionRemoveOptions)} instead
      */
+    @Deprecated
     void drop(EdgeCollectionDropOptions options);
 
+    /**
+     * Remove one edge definition from the graph.
+     *
+     * @see <a href=
+     * "https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-an-edge-definition-from-the-graph">API
+     * Documentation</a>
+     */
+    void remove();
+
+    /**
+     * Remove one edge definition from the graph.
+     *
+     * @param options options
+     * @see <a href=
+     * "https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-an-edge-definition-from-the-graph">API
+     * Documentation</a>
+     */
+    void remove(EdgeCollectionRemoveOptions options);
+
     /**
      * Creates a new edge in the collection
      *

core/src/main/java/com/arangodb/ArangoEdgeCollectionAsync.java

@@ -49,14 +49,30 @@ public interface ArangoEdgeCollectionAsync extends ArangoSerdeAccessor {
 
     /**
      * Asynchronous version of {@link ArangoEdgeCollection#drop()}
+     *
+     * @deprecated use {@link #remove()} instead
      */
+    @Deprecated
     CompletableFuture<Void> drop();
 
     /**
      * Asynchronous version of {@link ArangoEdgeCollection#drop(EdgeCollectionDropOptions)}
+     *
+     * @deprecated use {@link #remove(EdgeCollectionRemoveOptions)} instead
      */
+    @Deprecated
     CompletableFuture<Void> drop(EdgeCollectionDropOptions options);
 
+    /**
+     * Asynchronous version of {@link ArangoEdgeCollection#remove()}
+     */
+    CompletableFuture<Void> remove();
+
+    /**
+     * Asynchronous version of {@link ArangoEdgeCollection#remove(EdgeCollectionRemoveOptions)}
+     */
+    CompletableFuture<Void> remove(EdgeCollectionRemoveOptions options);
+
     /**
      * Asynchronous version of {@link ArangoEdgeCollection#insertEdge(Object)}
      */

core/src/main/java/com/arangodb/ArangoVertexCollection.java

@@ -54,7 +54,10 @@ public interface ArangoVertexCollection extends ArangoSerdeAccessor {
      *
      * @see <a href="https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-vertex-collection">API
      * Documentation</a>
+     *
+     * @deprecated use {@link #remove()} instead
      */
+    @Deprecated
     void drop();
 
     /**
@@ -63,9 +66,29 @@ public interface ArangoVertexCollection extends ArangoSerdeAccessor {
      * @param options options
      * @see <a href="https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-vertex-collection">API
      * Documentation</a>
+     *
+     * @deprecated use {@link #remove(VertexCollectionRemoveOptions)} instead
      */
+    @Deprecated
     void drop(VertexCollectionDropOptions options);
 
+    /**
+     * Remove a vertex collection form the graph.
+     *
+     * @see <a href="https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-vertex-collection">API
+     * Documentation</a>
+     */
+    void remove();
+
+    /**
+     * Remove a vertex collection form the graph.
+     *
+     * @param options options
+     * @see <a href="https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-vertex-collection">API
+     * Documentation</a>
+     */
+    void remove(VertexCollectionRemoveOptions options);
+
     /**
      * Creates a new vertex in the collection
      *

core/src/main/java/com/arangodb/ArangoVertexCollectionAsync.java

@@ -49,14 +49,30 @@ public interface ArangoVertexCollectionAsync extends ArangoSerdeAccessor {
 
     /**
      * Asynchronous version of {@link ArangoVertexCollection#drop()}
+     *
+     * @deprecated use {@link #remove()} instead
      */
+    @Deprecated
     CompletableFuture<Void> drop();
 
     /**
      * Asynchronous version of {@link ArangoVertexCollection#drop(VertexCollectionDropOptions)}
+     *
+     * @deprecated use {@link #remove(VertexCollectionRemoveOptions)} instead
      */
+    @Deprecated
     CompletableFuture<Void> drop(VertexCollectionDropOptions options);
 
+    /**
+     * Asynchronous version of {@link ArangoVertexCollection#remove()}
+     */
+    CompletableFuture<Void> remove();
+
+    /**
+     * Asynchronous version of {@link ArangoVertexCollection#remove(VertexCollectionRemoveOptions)}
+     */
+    CompletableFuture<Void> remove(VertexCollectionRemoveOptions options);
+
     /**
      * Asynchronous version of {@link ArangoVertexCollection#insertVertex(Object)}
      */

core/src/main/java/com/arangodb/internal/ArangoEdgeCollectionAsyncImpl.java

@@ -49,16 +49,28 @@ public ArangoGraphAsync graph() {
         return graph;
     }
 
+    @Deprecated
     @Override
     public CompletableFuture<Void> drop() {
         return drop(new EdgeCollectionDropOptions());
     }
 
+    @Deprecated
     @Override
     public CompletableFuture<Void> drop(final EdgeCollectionDropOptions options) {
         return executorAsync().execute(() -> removeEdgeDefinitionRequest(options), Void.class);
     }
 
+    @Override
+    public CompletableFuture<Void> remove() {
+        return remove(new EdgeCollectionRemoveOptions());
+    }
+
+    @Override
+    public CompletableFuture<Void> remove(final EdgeCollectionRemoveOptions options) {
+        return executorAsync().execute(() -> removeEdgeDefinitionRequest(options), Void.class);
+    }
+
     @Override
     public CompletableFuture<EdgeEntity> insertEdge(final Object value) {
         return executorAsync().execute(() -> insertEdgeRequest(value, new EdgeCreateOptions()),

core/src/main/java/com/arangodb/internal/ArangoEdgeCollectionImpl.java

@@ -46,16 +46,28 @@ public ArangoGraph graph() {
         return graph;
     }
 
+    @Deprecated
     @Override
     public void drop() {
         drop(new EdgeCollectionDropOptions());
     }
 
+    @Deprecated
     @Override
     public void drop(final EdgeCollectionDropOptions options) {
         executorSync().execute(removeEdgeDefinitionRequest(options), Void.class);
     }
 
+    @Override
+    public void remove() {
+        remove(new EdgeCollectionRemoveOptions());
+    }
+
+    @Override
+    public void remove(final EdgeCollectionRemoveOptions options) {
+        executorSync().execute(removeEdgeDefinitionRequest(options), Void.class);
+    }
+
     @Override
     public EdgeEntity insertEdge(final Object value) {
         return executorSync().execute(insertEdgeRequest(value, new EdgeCreateOptions()),

core/src/main/java/com/arangodb/internal/ArangoVertexCollectionAsyncImpl.java

@@ -49,16 +49,28 @@ public ArangoGraphAsync graph() {
         return graph;
     }
 
+    @Deprecated
     @Override
     public CompletableFuture<Void> drop() {
         return drop(new VertexCollectionDropOptions());
     }
 
+    @Deprecated
     @Override
     public CompletableFuture<Void> drop(final VertexCollectionDropOptions options) {
         return executorAsync().execute(() -> dropRequest(options), Void.class);
     }
 
+    @Override
+    public CompletableFuture<Void> remove() {
+        return remove(new VertexCollectionRemoveOptions());
+    }
+
+    @Override
+    public CompletableFuture<Void> remove(final VertexCollectionRemoveOptions options) {
+        return executorAsync().execute(() -> removeVertexCollectionRequest(options), Void.class);
+    }
+
     @Override
     public CompletableFuture<VertexEntity> insertVertex(final Object value) {
         return executorAsync().execute(() -> insertVertexRequest(value, new VertexCreateOptions()),

core/src/main/java/com/arangodb/internal/ArangoVertexCollectionImpl.java

@@ -46,16 +46,28 @@ public ArangoGraph graph() {
         return graph;
     }
 
+    @Deprecated
     @Override
     public void drop() {
         drop(new VertexCollectionDropOptions());
     }
 
+    @Deprecated
     @Override
     public void drop(final VertexCollectionDropOptions options) {
         executorSync().execute(dropRequest(options), Void.class);
     }
 
+    @Override
+    public void remove() {
+        remove(new VertexCollectionRemoveOptions());
+    }
+
+    @Override
+    public void remove(final VertexCollectionRemoveOptions options) {
+        executorSync().execute(removeVertexCollectionRequest(options), Void.class);
+    }
+
     @Override
     public VertexEntity insertVertex(final Object value) {
         return executorSync().execute(insertVertexRequest(value, new VertexCreateOptions()),

core/src/main/java/com/arangodb/internal/InternalArangoEdgeCollection.java

@@ -55,12 +55,19 @@ public String name() {
         return name;
     }
 
+    @Deprecated
     protected InternalRequest removeEdgeDefinitionRequest(final EdgeCollectionDropOptions options) {
         return request(dbName, RequestType.DELETE, PATH_API_GHARIAL, graphName, "edge", name)
                 .putQueryParam("waitForSync", options.getWaitForSync())
                 .putQueryParam("dropCollections", options.getDropCollections());
     }
 
+    protected InternalRequest removeEdgeDefinitionRequest(final EdgeCollectionRemoveOptions options) {
+        return request(dbName, RequestType.DELETE, PATH_API_GHARIAL, graphName, "edge", name)
+                .putQueryParam("waitForSync", options.getWaitForSync())
+                .putQueryParam("dropCollections", options.getDropCollections());
+    }
+
     protected <T> InternalRequest insertEdgeRequest(final T value, final EdgeCreateOptions options) {
         final InternalRequest request = request(dbName, RequestType.POST, PATH_API_GHARIAL, graphName, EDGE_PATH,
                 name);

core/src/main/java/com/arangodb/internal/InternalArangoVertexCollection.java

@@ -55,11 +55,17 @@ public String name() {
         return name;
     }
 
+    @Deprecated
     protected InternalRequest dropRequest(final VertexCollectionDropOptions options) {
         return request(dbName, RequestType.DELETE, PATH_API_GHARIAL, graphName, VERTEX_PATH, name)
                 .putQueryParam("dropCollection", options.getDropCollection());
     }
 
+    protected InternalRequest removeVertexCollectionRequest(final VertexCollectionRemoveOptions options) {
+        return request(dbName, RequestType.DELETE, PATH_API_GHARIAL, graphName, VERTEX_PATH, name)
+                .putQueryParam("dropCollection", options.getDropCollection());
+    }
+
     protected <T> InternalRequest insertVertexRequest(final T value, final VertexCreateOptions options) {
         final InternalRequest request = request(dbName, RequestType.POST, PATH_API_GHARIAL, graphName, VERTEX_PATH,
                 name);

core/src/main/java/com/arangodb/model/EdgeCollectionDropOptions.java

@@ -1,5 +1,9 @@
 package com.arangodb.model;
 
+/**
+ * @deprecated use {@link EdgeCollectionRemoveOptions} instead
+ */
+@Deprecated
 public class EdgeCollectionDropOptions {
     private Boolean waitForSync;
     private Boolean dropCollections;

core/src/main/java/com/arangodb/model/EdgeCollectionRemoveOptions.java

@@ -0,0 +1,33 @@
+package com.arangodb.model;
+
+public class EdgeCollectionRemoveOptions {
+    private Boolean waitForSync;
+    private Boolean dropCollections;
+
+    public Boolean getWaitForSync() {
+        return waitForSync;
+    }
+
+    /**
+     * @param waitForSync Define if the request should wait until synced to disk.
+     * @return this
+     */
+    public EdgeCollectionRemoveOptions waitForSync(Boolean waitForSync) {
+        this.waitForSync = waitForSync;
+        return this;
+    }
+
+    public Boolean getDropCollections() {
+        return dropCollections;
+    }
+
+    /**
+     * @param dropCollections Drop the collection as well. Collection will only be dropped if it is not used in other
+     *                        graphs.
+     * @return this
+     */
+    public EdgeCollectionRemoveOptions dropCollections(Boolean dropCollections) {
+        this.dropCollections = dropCollections;
+        return this;
+    }
+}

core/src/main/java/com/arangodb/model/VertexCollectionDropOptions.java

@@ -3,7 +3,10 @@
 /**
  * @see <a href="https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-vertex-collection">API
  * Documentation</a>
+ *
+ * @deprecated use {@link VertexCollectionRemoveOptions} instead
  */
+@Deprecated
 public class VertexCollectionDropOptions {
     private Boolean dropCollection;
 

core/src/main/java/com/arangodb/model/VertexCollectionRemoveOptions.java

@@ -0,0 +1,23 @@
+package com.arangodb.model;
+
+/**
+ * @see <a href="https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-vertex-collection">API
+ * Documentation</a>
+ */
+public class VertexCollectionRemoveOptions {
+    private Boolean dropCollection;
+
+    public Boolean getDropCollection() {
+        return dropCollection;
+    }
+
+    /**
+     * @param dropCollection Drop the collection as well. Collection will only be dropped if it is not used in other
+     *                       graphs.
+     * @return this
+     */
+    public VertexCollectionRemoveOptions dropCollection(Boolean dropCollection) {
+        this.dropCollection = dropCollection;
+        return this;
+    }
+}