Skip to content

[DE-313] Allow specifying the return type in CRUD document operations #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 11, 2022
Merged

[DE-313] Allow specifying the return type in CRUD document operations #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9639ac7
typed ArangoCollection#insertDocument
rashtao Aug 10, 2022
7b6800a
typed ArangoCollection#updateDocument
rashtao Aug 11, 2022
f2a7741
typed ArangoCollection#replaceDocument
rashtao Aug 11, 2022
cf1da0e
typed ArangoCollection#insertDocuments
rashtao Aug 11, 2022
e3adc90
typed ArangoCollection#deleteDocument
rashtao Aug 11, 2022
e5a860c
typed ArangoCollection#updateDocuments
rashtao Aug 11, 2022
89ef22a
typed ArangoCollection#replaceDocuments
rashtao Aug 11, 2022
b887856
typed ArangoCollection#deleteDocuments
rashtao Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 95 additions & 32 deletions src/main/java/com/arangodb/ArangoCollection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public interface ArangoCollection extends ArangoSerdeAccessor {
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
* Documentation</a>
*/
<T> DocumentCreateEntity<T> insertDocument(T value) throws ArangoDBException;
DocumentCreateEntity<Void> insertDocument(Object value) throws ArangoDBException;

/**
* Creates a new document from the given document, unless there is already a document with the _key given. If no
Expand All @@ -76,27 +76,35 @@ public interface ArangoCollection extends ArangoSerdeAccessor {
*/
<T> DocumentCreateEntity<T> insertDocument(T value, DocumentCreateOptions options) throws ArangoDBException;

/**
* Creates a new document from the given document, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param value A representation of a single document (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @param options Additional options, can be null
* @param type Deserialization target type for the returned documents.
* @return information about the document
* @throws ArangoDBException
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
* Documentation</a>
*/
<T> DocumentCreateEntity<T> insertDocument(T value, DocumentCreateOptions options, Class<T> type) throws ArangoDBException;

/**
* Creates new documents from the given documents, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @return information about the documents
* @throws ArangoDBException
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
* Documentation</a>
*/
<T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values) throws ArangoDBException;
MultiDocumentEntity<DocumentCreateEntity<Void>> insertDocuments(Collection<?> values) throws ArangoDBException;

/**
* Creates new documents from the given documents, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @param options Additional options, can be null
Expand All @@ -108,11 +116,23 @@ public interface ArangoCollection extends ArangoSerdeAccessor {
<T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
Collection<T> values, DocumentCreateOptions options) throws ArangoDBException;

/**
* Creates new documents from the given documents, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @param options Additional options, can be null
* @param type Deserialization target type for the returned documents.
* @return information about the documents
* @throws ArangoDBException
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#create-document">API
* Documentation</a>
*/
<T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(
Collection<T> values, DocumentCreateOptions options, Class<T> type) throws ArangoDBException;

/**
* Bulk imports the given values into the collection.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values a list of Objects that will be stored as documents
* @return information about the import
Expand All @@ -122,9 +142,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(

/**
* Bulk imports the given values into the collection.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values a list of Objects that will be stored as documents
* @param options Additional options, can be null
Expand All @@ -135,9 +152,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(

/**
* Bulk imports the given values into the collection.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values JSON-encoded array of objects that will be stored as documents
* @return information about the import
Expand All @@ -147,9 +161,6 @@ <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(

/**
* Bulk imports the given values into the collection.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values JSON-encoded array of objects that will be stored as documents
* @param options Additional options, can be null
Expand Down Expand Up @@ -216,7 +227,7 @@ <T> MultiDocumentEntity<T> getDocuments(Collection<String> keys, Class<T> type,
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-document">API
* Documentation</a>
*/
<T> DocumentUpdateEntity<T> replaceDocument(String key, T value) throws ArangoDBException;
DocumentUpdateEntity<Void> replaceDocument(String key, Object value) throws ArangoDBException;

/**
* Replaces the document with {@code key} with the one in the body, provided there is such a document and no
Expand All @@ -233,27 +244,37 @@ <T> MultiDocumentEntity<T> getDocuments(Collection<String> keys, Class<T> type,
<T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplaceOptions options)
throws ArangoDBException;

/**
* Replaces the document with {@code key} with the one in the body, provided there is such a document and no
* precondition is violated
*
* @param key The key of the document
* @param value A representation of a single document (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @param options Additional options, can be null
* @param type Deserialization target type for the returned documents.
* @return information about the document
* @throws ArangoDBException
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-document">API
* Documentation</a>
*/
<T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplaceOptions options, Class<T> type)
throws ArangoDBException;

/**
* Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
* specified by the _key attributes in the documents in values.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @return information about the documents
* @throws ArangoDBException
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
* Documentation</a>
*/
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values) throws ArangoDBException;
MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(Collection<?> values) throws ArangoDBException;

/**
* Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
* specified by the _key attributes in the documents in values.
* <p>
* Limitations:
* - the fields having {@code null} value are always removed during serialization
*
* @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @param options Additional options, can be null
Expand All @@ -265,6 +286,21 @@ <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplace
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
Collection<T> values, DocumentReplaceOptions options) throws ArangoDBException;

/**
* Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
* specified by the _key attributes in the documents in values.
*
* @param values A List of documents (POJO, {@link com.arangodb.util.RawJson} or {@link com.arangodb.util.RawBytes})
* @param options Additional options, can be null
* @param type Deserialization target type for the returned documents.
* @return information about the documents
* @throws ArangoDBException
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#replace-documents">API
* Documentation</a>
*/
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
Collection<T> values, DocumentReplaceOptions options, Class<T> type) throws ArangoDBException;

/**
* Partially updates the document identified by document-key. The value must contain a document with the attributes
* to patch (the patch document). All attributes from the patch document will be added to the existing document if
Expand All @@ -277,7 +313,7 @@ <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#update-document">API
* Documentation</a>
*/
<T> DocumentUpdateEntity<T> updateDocument(String key, T value) throws ArangoDBException;
DocumentUpdateEntity<Void> updateDocument(String key, Object value) throws ArangoDBException;

/**
* Partially updates the document identified by document-key. The value must contain a document with the attributes
Expand Down Expand Up @@ -324,7 +360,7 @@ <T, U> DocumentUpdateEntity<U> updateDocument(String key, T value, DocumentUpdat
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#update-documents">API
* Documentation</a>
*/
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Collection<T> values) throws ArangoDBException;
MultiDocumentEntity<DocumentUpdateEntity<Void>> updateDocuments(Collection<?> values) throws ArangoDBException;

/**
* Partially updates documents, the documents to update are specified by the _key attributes in the objects on
Expand Down Expand Up @@ -370,6 +406,19 @@ <T, U> MultiDocumentEntity<DocumentUpdateEntity<U>> updateDocuments(
*/
DocumentDeleteEntity<Void> deleteDocument(String key) throws ArangoDBException;

/**
* Deletes the document with the given {@code key} from the collection.
*
* @param key The key of the document
* @param options Additional options, can be null
* @return information about the document
* @throws ArangoDBException
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-a-document">API
* Documentation</a>
*/
<T> DocumentDeleteEntity<T> deleteDocument(String key, DocumentDeleteOptions options)
throws ArangoDBException;

/**
* Deletes the document with the given {@code key} from the collection.
*
Expand All @@ -382,7 +431,7 @@ <T, U> MultiDocumentEntity<DocumentUpdateEntity<U>> updateDocuments(
* @see <a href="https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-a-document">API
* Documentation</a>
*/
<T> DocumentDeleteEntity<T> deleteDocument(String key, Class<T> type, DocumentDeleteOptions options)
<T> DocumentDeleteEntity<T> deleteDocument(String key, DocumentDeleteOptions options, Class<T> type)
throws ArangoDBException;

/**
Expand All @@ -397,6 +446,20 @@ <T> DocumentDeleteEntity<T> deleteDocument(String key, Class<T> type, DocumentDe
*/
MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(Collection<?> values) throws ArangoDBException;

/**
* Deletes multiple documents from the collection.
*
* @param values The keys of the documents or the documents themselves
* @param options Additional options, can be null
* @return information about the documents
* @throws ArangoDBException
* @see <a href=
* "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-multiple-documents">API
* Documentation</a>
*/
<T> MultiDocumentEntity<DocumentDeleteEntity<T>> deleteDocuments(
Collection<?> values, DocumentDeleteOptions options) throws ArangoDBException;

/**
* Deletes multiple documents from the collection.
*
Expand All @@ -411,7 +474,7 @@ <T> DocumentDeleteEntity<T> deleteDocument(String key, Class<T> type, DocumentDe
* Documentation</a>
*/
<T> MultiDocumentEntity<DocumentDeleteEntity<T>> deleteDocuments(
Collection<?> values, Class<T> type, DocumentDeleteOptions options) throws ArangoDBException;
Collection<?> values, DocumentDeleteOptions options, Class<T> type) throws ArangoDBException;

/**
* Checks if the document exists by reading a single document head
Expand Down
Loading