changed ArangoCollection.deleteDocuments() to work with keys+docs

Author: Mark

ChangeLog

@@ -9,6 +9,7 @@ v4.1.8 (2017-02-xx)
 * added byte[] de-/serialization from/to VPack.string (Base64)
 * added ArangoCollection.drop(isSystem)
 * improved ArangoDBException with responseCode, errorNum, errorMessage
+* changed ArangoCollection.deleteDocuments() to work with keys and documents
 
 v4.1.7 (2017-01-26)
 ---------------------------

src/main/java/com/arangodb/ArangoCollectionAsync.java

@@ -440,16 +440,16 @@ public <T> CompletableFuture<DocumentDeleteEntity<T>> deleteDocument(
 	 * @see <a href=
 	 *      "https://docs.arangodb.com/current/HTTP/Document/WorkingWithDocuments.html#removes-multiple-documents">API
 	 *      Documentation</a>
-	 * @param keys
-	 *            The keys of the documents
+	 * @param values
+	 *            The keys of the documents or the documents themselves
 	 * @param type
 	 *            The type of the documents (POJO class, VPackSlice or String for Json). Only necessary if
 	 *            options.returnOld is set to true, otherwise can be null.
 	 * @return information about the documents
 	 */
 	public CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<Void>>> deleteDocuments(
-		final Collection<String> keys) {
-		return executor.execute(deleteDocumentsRequest(keys, new DocumentDeleteOptions()),
+		final Collection<?> values) {
+		return executor.execute(deleteDocumentsRequest(values, new DocumentDeleteOptions()),
 			deleteDocumentsResponseDeserializer(Void.class));
 	}
 
@@ -459,8 +459,8 @@ public CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<Void>>> delete
 	 * @see <a href=
 	 *      "https://docs.arangodb.com/current/HTTP/Document/WorkingWithDocuments.html#removes-multiple-documents">API
 	 *      Documentation</a>
-	 * @param keys
-	 *            The keys of the documents
+	 * @param values
+	 *            The keys of the documents or the documents themselves
 	 * @param type
 	 *            The type of the documents (POJO class, VPackSlice or String for Json). Only necessary if
 	 *            options.returnOld is set to true, otherwise can be null.
@@ -469,10 +469,10 @@ public CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<Void>>> delete
 	 * @return information about the documents
 	 */
 	public <T> CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<T>>> deleteDocuments(
-		final Collection<String> keys,
+		final Collection<?> values,
 		final Class<T> type,
 		final DocumentDeleteOptions options) {
-		return executor.execute(deleteDocumentsRequest(keys, options), deleteDocumentsResponseDeserializer(type));
+		return executor.execute(deleteDocumentsRequest(values, options), deleteDocumentsResponseDeserializer(type));
 	}
 
 	/**

src/test/java/com/arangodb/ArangoCollectionTest.java

@@ -1508,7 +1508,7 @@ public void importDocumentsJsonFromToPrefix() throws InterruptedException, Execu
 	}
 
 	@Test
-	public void deleteDocuments() throws InterruptedException, ExecutionException {
+	public void deleteDocumentsByKey() throws InterruptedException, ExecutionException {
 		final Collection<BaseDocument> values = new ArrayList<>();
 		{
 			final BaseDocument e = new BaseDocument();
@@ -1539,7 +1539,35 @@ public void deleteDocuments() throws InterruptedException, ExecutionException {
 	}
 
 	@Test
-	public void deleteDocumentsOne() throws InterruptedException, ExecutionException {
+	public void deleteDocumentsByDocuments() throws InterruptedException, ExecutionException {
+		final Collection<BaseDocument> values = new ArrayList<>();
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("1");
+			values.add(e);
+		}
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("2");
+			values.add(e);
+		}
+		db.collection(COLLECTION_NAME).insertDocuments(values, null);
+		final CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<Object>>> f = db.collection(COLLECTION_NAME)
+				.deleteDocuments(values, null, null);
+		assertThat(f, is(notNullValue()));
+		f.whenComplete((deleteResult, ex) -> {
+			assertThat(deleteResult, is(notNullValue()));
+			assertThat(deleteResult.getDocuments().size(), is(2));
+			for (final DocumentDeleteEntity<Object> i : deleteResult.getDocuments()) {
+				assertThat(i.getKey(), anyOf(is("1"), is("2")));
+			}
+			assertThat(deleteResult.getErrors().size(), is(0));
+		});
+		f.get();
+	}
+
+	@Test
+	public void deleteDocumentsByKeyOne() throws InterruptedException, ExecutionException {
 		final Collection<BaseDocument> values = new ArrayList<>();
 		{
 			final BaseDocument e = new BaseDocument();
@@ -1563,6 +1591,29 @@ public void deleteDocumentsOne() throws InterruptedException, ExecutionException
 		f.get();
 	}
 
+	@Test
+	public void deleteDocumentsByDocumentOne() throws InterruptedException, ExecutionException {
+		final Collection<BaseDocument> values = new ArrayList<>();
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("1");
+			values.add(e);
+		}
+		db.collection(COLLECTION_NAME).insertDocuments(values, null);
+		final CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<Object>>> f = db.collection(COLLECTION_NAME)
+				.deleteDocuments(values, null, null);
+		assertThat(f, is(notNullValue()));
+		f.whenComplete((deleteResult, ex) -> {
+			assertThat(deleteResult, is(notNullValue()));
+			assertThat(deleteResult.getDocuments().size(), is(1));
+			for (final DocumentDeleteEntity<Object> i : deleteResult.getDocuments()) {
+				assertThat(i.getKey(), is("1"));
+			}
+			assertThat(deleteResult.getErrors().size(), is(0));
+		});
+		f.get();
+	}
+
 	@Test
 	public void deleteDocumentsEmpty() throws InterruptedException, ExecutionException {
 		final Collection<BaseDocument> values = new ArrayList<>();
@@ -1580,7 +1631,7 @@ public void deleteDocumentsEmpty() throws InterruptedException, ExecutionExcepti
 	}
 
 	@Test
-	public void deleteDocumentsNotExisting() throws InterruptedException, ExecutionException {
+	public void deleteDocumentsByKeyNotExisting() throws InterruptedException, ExecutionException {
 		final Collection<BaseDocument> values = new ArrayList<>();
 		db.collection(COLLECTION_NAME).insertDocuments(values, null);
 		final Collection<String> keys = new ArrayList<>();
@@ -1597,6 +1648,30 @@ public void deleteDocumentsNotExisting() throws InterruptedException, ExecutionE
 		f.get();
 	}
 
+	@Test
+	public void deleteDocumentsByDocumentsNotExisting() throws InterruptedException, ExecutionException {
+		final Collection<BaseDocument> values = new ArrayList<>();
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("1");
+			values.add(e);
+		}
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("2");
+			values.add(e);
+		}
+		final CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<Object>>> f = db.collection(COLLECTION_NAME)
+				.deleteDocuments(values, null, null);
+		assertThat(f, is(notNullValue()));
+		f.whenComplete((deleteResult, ex) -> {
+			assertThat(deleteResult, is(notNullValue()));
+			assertThat(deleteResult.getDocuments().size(), is(0));
+			assertThat(deleteResult.getErrors().size(), is(2));
+		});
+		f.get();
+	}
+
 	@Test
 	public void updateDocuments() throws InterruptedException, ExecutionException {
 		final Collection<BaseDocument> values = new ArrayList<>();