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

Author: Mark

ChangeLog

@@ -6,6 +6,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/ArangoCollection.java

@@ -456,17 +456,17 @@ public <T> 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
 	 * @throws ArangoDBException
 	 */
-	public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(final Collection<String> keys)
+	public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(final Collection<?> values)
 			throws ArangoDBException {
-		return executor.execute(deleteDocumentsRequest(keys, new DocumentDeleteOptions()),
+		return executor.execute(deleteDocumentsRequest(values, new DocumentDeleteOptions()),
 			deleteDocumentsResponseDeserializer(Void.class));
 	}
 
@@ -476,8 +476,8 @@ public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(final Col
 	 * @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.
@@ -487,10 +487,10 @@ public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(final Col
 	 * @throws ArangoDBException
 	 */
 	public <T> MultiDocumentEntity<DocumentDeleteEntity<T>> deleteDocuments(
-		final Collection<String> keys,
+		final Collection<?> values,
 		final Class<T> type,
 		final DocumentDeleteOptions options) throws ArangoDBException {
-		return executor.execute(deleteDocumentsRequest(keys, options), deleteDocumentsResponseDeserializer(type));
+		return executor.execute(deleteDocumentsRequest(values, options), deleteDocumentsResponseDeserializer(type));
 	}
 
 	/**

src/main/java/com/arangodb/internal/InternalArangoCollection.java

@@ -409,7 +409,7 @@ public DocumentDeleteEntity<T> deserialize(final Response response) throws VPack
 		};
 	}
 
-	protected Request deleteDocumentsRequest(final Collection<String> keys, final DocumentDeleteOptions options) {
+	protected <T> Request deleteDocumentsRequest(final Collection<T> keys, final DocumentDeleteOptions options) {
 		final Request request;
 		request = new Request(db, RequestType.DELETE, executor.createPath(ArangoDBConstants.PATH_API_DOCUMENT, name));
 		final DocumentDeleteOptions params = (options != null ? options : new DocumentDeleteOptions());

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

@@ -1322,7 +1322,7 @@ public void importDocumentsJsonFromToPrefix() {
 	}
 
 	@Test
-	public void deleteDocuments() {
+	public void deleteDocumentsByKey() {
 		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();
 		{
 			final BaseDocument e = new BaseDocument();
@@ -1349,7 +1349,31 @@ public void deleteDocuments() {
 	}
 
 	@Test
-	public void deleteDocumentsOne() {
+	public void deleteDocumentsByDocuments() {
+		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();
+		{
+			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 MultiDocumentEntity<DocumentDeleteEntity<Object>> deleteResult = db.collection(COLLECTION_NAME)
+				.deleteDocuments(values, null, null);
+		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));
+	}
+
+	@Test
+	public void deleteDocumentsByKeyOne() {
 		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();
 		{
 			final BaseDocument e = new BaseDocument();
@@ -1369,6 +1393,25 @@ public void deleteDocumentsOne() {
 		assertThat(deleteResult.getErrors().size(), is(0));
 	}
 
+	@Test
+	public void deleteDocumentsByDocumentOne() {
+		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("1");
+			values.add(e);
+		}
+		db.collection(COLLECTION_NAME).insertDocuments(values, null);
+		final MultiDocumentEntity<DocumentDeleteEntity<Object>> deleteResult = db.collection(COLLECTION_NAME)
+				.deleteDocuments(values, null, null);
+		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));
+	}
+
 	@Test
 	public void deleteDocumentsEmpty() {
 		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();
@@ -1382,7 +1425,7 @@ public void deleteDocumentsEmpty() {
 	}
 
 	@Test
-	public void deleteDocumentsNotExisting() {
+	public void deleteDocumentsByKeyNotExisting() {
 		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();
 		db.collection(COLLECTION_NAME).insertDocuments(values, null);
 		final Collection<String> keys = new ArrayList<String>();
@@ -1395,6 +1438,26 @@ public void deleteDocumentsNotExisting() {
 		assertThat(deleteResult.getErrors().size(), is(2));
 	}
 
+	@Test
+	public void deleteDocumentsByDocumentsNotExisting() {
+		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("1");
+			values.add(e);
+		}
+		{
+			final BaseDocument e = new BaseDocument();
+			e.setKey("2");
+			values.add(e);
+		}
+		final MultiDocumentEntity<DocumentDeleteEntity<Object>> deleteResult = db.collection(COLLECTION_NAME)
+				.deleteDocuments(values, null, null);
+		assertThat(deleteResult, is(notNullValue()));
+		assertThat(deleteResult.getDocuments().size(), is(0));
+		assertThat(deleteResult.getErrors().size(), is(2));
+	}
+
 	@Test
 	public void updateDocuments() {
 		final Collection<BaseDocument> values = new ArrayList<BaseDocument>();