removed Methods with documentId (long) from ArangoDriver

Author: Mark

ChangeLog

@@ -1,6 +1,7 @@
 v3.1.0 (2016-09-XX)
 * removed Methods with collectionId (long) from ArangoDriver (Id is only for internal usage)
 * changed Revision from long to String
+* removed Methods with documentId (long) from ArangoDriver
 
 v3.0.1 (2016-07-08)
 ---------------------------

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

@@ -746,23 +746,6 @@ public <T> DocumentEntity<T> createDocument(
 		return documentDriver.createDocument(getDefaultDatabase(), collectionName, documentKey, value, waitForSync);
 	}
 
-	/**
-	 * This method replaces the content of the document defined by documentId.
-	 *
-	 * @param collectionName
-	 *            The collection's name.
-	 * @param documentId
-	 *            The document's id.
-	 * @param value
-	 *            An object containing the documents attributes
-	 * @return DocumentEntity<?>
-	 * @throws ArangoException
-	 */
-	public <T> DocumentEntity<T> replaceDocument(final String collectionName, final long documentId, final T value)
-			throws ArangoException {
-		return replaceDocument(createDocumentHandle(collectionName, String.valueOf(documentId)), value, null, null);
-	}
-
 	/**
 	 * This method replaces the content of the document defined by documentKey.
 	 *
@@ -795,36 +778,6 @@ public <T> DocumentEntity<T> replaceDocument(final String documentHandle, final
 		return documentDriver.replaceDocument(getDefaultDatabase(), documentHandle, value, null, null);
 	}
 
-	/**
-	 * This method replaces the content of the document defined by documentId.
-	 * This method offers a parameter rev (revision). If the revision of the
-	 * document on the server does not match the given revision an error is
-	 * thrown.
-	 *
-	 * @param collectionName
-	 *            The collection's name.
-	 * @param documentId
-	 *            The document's id.
-	 * @param value
-	 *            An object containing the new attributes of the document.
-	 * @param rev
-	 *            the desired revision.
-	 * @param waitForSync
-	 *            if set to true the response is returned when the server has
-	 *            finished.
-	 * @return a DocumentEntity object
-	 * @throws ArangoException
-	 */
-	public DocumentEntity<?> replaceDocument(
-		final String collectionName,
-		final long documentId,
-		final Object value,
-		final String rev,
-		final Boolean waitForSync) throws ArangoException {
-		return replaceDocument(createDocumentHandle(collectionName, String.valueOf(documentId)), value, rev,
-			waitForSync);
-	}
-
 	/**
 	 * This method replaces the content of the document defined by documentKey.
 	 * This method offers a parameter rev (revision). If the revision of the
@@ -880,24 +833,6 @@ public <T> DocumentEntity<T> replaceDocument(
 		return documentDriver.replaceDocument(getDefaultDatabase(), documentHandle, value, rev, waitForSync);
 	}
 
-	/**
-	 * This method updates a document defined by documentId.
-	 *
-	 * @param collectionName
-	 *            The collection's name.
-	 * @param documentId
-	 *            The document's id.
-	 * @param value
-	 *            An object containing the documents attributes
-	 * @return DocumentEntity<?>
-	 * @throws ArangoException
-	 */
-	public DocumentEntity<?> updateDocument(final String collectionName, final long documentId, final Object value)
-			throws ArangoException {
-		return updateDocument(createDocumentHandle(collectionName, String.valueOf(documentId)), value, null, null,
-			null);
-	}
-
 	/**
 	 * This method updates a document defined by documentKey.
 	 *
@@ -929,29 +864,6 @@ public <T> DocumentEntity<T> updateDocument(final String documentHandle, final T
 		return documentDriver.updateDocument(getDefaultDatabase(), documentHandle, value, null, null, null);
 	}
 
-	/**
-	 * This method updates a document defined by documentId.
-	 *
-	 * @param collectionName
-	 *            The collection name.
-	 * @param documentId
-	 *            The document id.
-	 * @param value
-	 *            An object containing the documents attributes
-	 * @param keepNull
-	 *            If true null values are kept.
-	 * @return DocumentEntity<?>
-	 * @throws ArangoException
-	 */
-	public DocumentEntity<?> updateDocument(
-		final String collectionName,
-		final long documentId,
-		final Object value,
-		final Boolean keepNull) throws ArangoException {
-		return updateDocument(createDocumentHandle(collectionName, String.valueOf(documentId)), value, null, null,
-			keepNull);
-	}
-
 	/**
 	 * This method updates a document defined by documentKey.
 	 *
@@ -991,38 +903,6 @@ public <T> DocumentEntity<T> updateDocument(final String documentHandle, final T
 		return documentDriver.updateDocument(getDefaultDatabase(), documentHandle, value, null, null, keepNull);
 	}
 
-	/**
-	 * This method updates a document defined by documentId. This method offers
-	 * a parameter rev (revision). If the revision of the document on the server
-	 * does not match the given revision an error is thrown.
-	 *
-	 * @param collectionName
-	 *            The collection name.
-	 * @param documentId
-	 *            The document id.
-	 * @param value
-	 *            An object containing the documents attributes
-	 * @param rev
-	 *            The desired revision
-	 * @param waitForSync
-	 *            if set to true the response is returned when the server has
-	 *            finished.
-	 * @param keepNull
-	 *            If true null values are kept.
-	 * @return a DocumentEntity object
-	 * @throws ArangoException
-	 */
-	public DocumentEntity<?> updateDocument(
-		final String collectionName,
-		final long documentId,
-		final Object value,
-		final String rev,
-		final Boolean waitForSync,
-		final Boolean keepNull) throws ArangoException {
-		return updateDocument(createDocumentHandle(collectionName, String.valueOf(documentId)), value, rev, waitForSync,
-			keepNull);
-	}
-
 	/**
 	 * This method updates a document defined by documentKey. This method offers
 	 * a parameter rev (revision). If the revision of the document on the server
@@ -1094,23 +974,6 @@ public List<String> getDocuments(final String collectionName) throws ArangoExcep
 		return documentDriver.getDocuments(getDefaultDatabase(), collectionName);
 	}
 
-	/**
-	 * The exists method determines whether a document exists given its
-	 * identifier. Instead of returning the found document or an error, this
-	 * method will return either true or false. It can thus be used for easy
-	 * existence checks.
-	 *
-	 * @param collectionName
-	 *            The collection name.
-	 * @param documentId
-	 *            The document id
-	 * @return true, if the document exists
-	 * @throws ArangoException
-	 */
-	public boolean exists(final String collectionName, final long documentId) throws ArangoException {
-		return exists(createDocumentHandle(collectionName, String.valueOf(documentId)));
-	}
-
 	/**
 	 * The exists method determines whether a document exists given its
 	 * identifier. Instead of returning the found document or an error, this
@@ -1151,20 +1014,6 @@ public boolean exists(final String documentHandle) throws ArangoException {
 		return true;
 	}
 
-	/**
-	 * This method returns the current revision of a document.
-	 *
-	 * @param collectionName
-	 *            The collection name.
-	 * @param documentId
-	 *            The document id
-	 * @return the document revision number
-	 * @throws ArangoException
-	 */
-	public String checkDocument(final String collectionName, final long documentId) throws ArangoException {
-		return checkDocument(createDocumentHandle(collectionName, String.valueOf(documentId)));
-	}
-
 	/**
 	 * This method returns the current revision of a document.
 	 *
@@ -1191,24 +1040,6 @@ public String checkDocument(final String documentHandle) throws ArangoException
 		return documentDriver.checkDocument(getDefaultDatabase(), documentHandle);
 	}
 
-	/**
-	 * Returns a document entity.
-	 *
-	 * @param collectionName
-	 *            The collection name.
-	 * @param documentId
-	 *            The document id
-	 * @param clazz
-	 *            The expected class, the result from the server request is
-	 *            deserialized to an instance of this class.
-	 * @return a DocumentEntity object
-	 * @throws ArangoException
-	 */
-	public <T> DocumentEntity<T> getDocument(final String collectionName, final long documentId, final Class<T> clazz)
-			throws ArangoException {
-		return getDocument(createDocumentHandle(collectionName, String.valueOf(documentId)), clazz);
-	}
-
 	/**
 	 * Returns a document entity.
 	 *
@@ -1272,20 +1103,6 @@ public <T> DocumentEntity<T> getDocument(
 			ifMatchRevision);
 	}
 
-	/**
-	 * Deletes a document from the database.
-	 *
-	 * @param collectionName
-	 *            The collection name.
-	 * @param documentId
-	 *            The document id.
-	 * @return a DocumentEntity object
-	 * @throws ArangoException
-	 */
-	public DocumentEntity<?> deleteDocument(final String collectionName, final long documentId) throws ArangoException {
-		return deleteDocument(createDocumentHandle(collectionName, String.valueOf(documentId)));
-	}
-
 	/**
 	 * Deletes a document from the database.
 	 *
@@ -1313,25 +1130,6 @@ public DocumentEntity<?> deleteDocument(final String documentHandle) throws Aran
 		return documentDriver.deleteDocument(getDefaultDatabase(), documentHandle, null);
 	}
 
-	/**
-	 * Deletes a document from the database. This method offers a parameter rev
-	 * (revision). If the revision of the document on the server does not match
-	 * the given revision an error is thrown.
-	 *
-	 * @param collectionName
-	 *            The collection name.
-	 * @param documentId
-	 *            The document id.
-	 * @param rev
-	 *            The desired revision
-	 * @return a DocumentEntity object
-	 * @throws ArangoException
-	 */
-	public DocumentEntity<?> deleteDocument(final String collectionName, final long documentId, final String rev)
-			throws ArangoException {
-		return deleteDocument(createDocumentHandle(collectionName, String.valueOf(documentId)), rev);
-	}
-
 	/**
 	 * Deletes a document from the database. This method offers a parameter rev
 	 * (revision). If the revision of the document on the server does not match

src/test/java/com/arangodb/ArangoDriverDocumentTest.java

@@ -278,7 +278,7 @@ public void test_replace_404() throws ArangoException {
 		final TestComplexEntity01 value = new TestComplexEntity01("test-user", "test user", 22);
 		// 存在しないコレクションに追加しようとする
 		try {
-			driver.replaceDocument(collectionName404, 1, value, null, null);
+			driver.replaceDocument(collectionName404, "1", value, null, null);
 			fail("no exception was thrown");
 		} catch (final ArangoException e) {
 			assertThat(e.getCode(), is(404));
@@ -291,7 +291,7 @@ public void test_replace_404_2() throws ArangoException {
 		final TestComplexEntity01 value = new TestComplexEntity01("test-user", "test user", 22);
 		// 存在するコレクションだが、ドキュメントが存在しない
 		try {
-			driver.replaceDocument(collectionName, 1, value, null, null);
+			driver.replaceDocument(collectionName, "1", value, null, null);
 			fail("no exception was thrown");
 		} catch (final ArangoException e) {
 			assertThat(e.getCode(), is(404));
@@ -470,7 +470,7 @@ public void test_get_document_with_instance_creator() throws ArangoException {
 	public void test_get_document_collection_not_found() throws ArangoException {
 		// Get
 		try {
-			driver.getDocument(collectionName404, 1L, TestComplexEntity01.class);
+			driver.getDocument(collectionName404, "1", TestComplexEntity01.class);
 			fail("");
 		} catch (final ArangoException e) {
 			assertThat(e.getCode(), is(404));
@@ -483,7 +483,7 @@ public void test_get_document_collection_not_found() throws ArangoException {
 	public void test_get_document_doc_not_found() throws ArangoException {
 		// Get
 		try {
-			driver.getDocument(collectionName, 1L, TestComplexEntity01.class);
+			driver.getDocument(collectionName, "1", TestComplexEntity01.class);
 			fail("");
 		} catch (final ArangoException e) {
 			assertThat(e.getCode(), is(404));
@@ -580,7 +580,7 @@ public void test_check_document_doc_not_found() throws ArangoException {
 		driver.createDocument(collectionName, new TestComplexEntity02(1, 2, 3), null);
 
 		try {
-			driver.checkDocument(collectionName, 1);
+			driver.checkDocument(collectionName, "1");
 			fail();
 		} catch (final ArangoException e) {
 			assertThat(e.getCode(), is(404));
@@ -593,7 +593,7 @@ public void test_check_document_doc_not_exists() throws ArangoException {
 
 		driver.createDocument(collectionName, new TestComplexEntity02(1, 2, 3), null);
 
-		final boolean b = driver.exists(collectionName, 1);
+		final boolean b = driver.exists(collectionName, "1");
 
 		assertThat(b, is(false));
 	}
@@ -608,7 +608,7 @@ public void test_delete() throws ArangoException {
 	@Test
 	public void test_delete_doc_not_found() throws ArangoException {
 		try {
-			driver.deleteDocument(collectionName, 1);
+			driver.deleteDocument(collectionName, "1");
 			fail();
 		} catch (final ArangoException e) {
 			assertThat(e.getCode(), is(ErrorNums.ERROR_HTTP_NOT_FOUND));

src/test/resources/logback.xml

@@ -8,7 +8,7 @@
     </encoder>
   </appender>
 
-  <root level="debug">
+  <root level="info">
     <appender-ref ref="STDOUT" />
   </root>
 </configuration>