summaryrefslogtreecommitdiffstats
path: root/documentapi
diff options
context:
space:
mode:
authorJon Bratseth <bratseth@gmail.com>2020-04-15 12:20:52 +0200
committerJon Bratseth <bratseth@gmail.com>2020-04-15 12:20:52 +0200
commitf6b90d5e48dfc894bb7c5299522f5cea0ec0c658 (patch)
tree4b133c3a092b403778d67ce9ebfcef6c6e3e236e /documentapi
parent1ee3a5aa8d674b1456b684c583a96092be91a344 (diff)
Nonfunctional changes only
Diffstat (limited to 'documentapi')
-rw-r--r--documentapi/src/main/java/com/yahoo/documentapi/DocumentOpVisitorResponse.java2
-rwxr-xr-xdocumentapi/src/main/java/com/yahoo/documentapi/SyncSession.java63
2 files changed, 31 insertions, 34 deletions
diff --git a/documentapi/src/main/java/com/yahoo/documentapi/DocumentOpVisitorResponse.java b/documentapi/src/main/java/com/yahoo/documentapi/DocumentOpVisitorResponse.java
index f5641b915f4..4316003acc6 100644
--- a/documentapi/src/main/java/com/yahoo/documentapi/DocumentOpVisitorResponse.java
+++ b/documentapi/src/main/java/com/yahoo/documentapi/DocumentOpVisitorResponse.java
@@ -10,6 +10,7 @@ import com.yahoo.document.DocumentOperation;
* @author Arne H Juul
*/
public class DocumentOpVisitorResponse extends VisitorResponse {
+
private DocumentOperation op;
/**
@@ -25,4 +26,5 @@ public class DocumentOpVisitorResponse extends VisitorResponse {
/** @return the document operation */
public DocumentOperation getDocumentOperation() { return op; }
+
}
diff --git a/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java b/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
index 6c4306b683c..cc0f6dc7cd5 100755
--- a/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
+++ b/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
@@ -23,15 +23,15 @@ public interface SyncSession extends Session {
* Puts a document. When this method returns, the document is safely
* received. This enables setting condition compared to using Document.
*
- * @param documentPut The DocumentPut operation
+ * @param documentPut the DocumentPut operation
*/
void put(DocumentPut documentPut);
/**
* Puts a document. When this method returns, the document is safely received.
*
- * @param documentPut The DocumentPut operation
- * @param priority The priority with which to perform this operation.
+ * @param documentPut the DocumentPut operation
+ * @param priority the priority with which to perform this operation
*/
default void put(DocumentPut documentPut, DocumentProtocol.Priority priority) {
put(documentPut);
@@ -40,11 +40,9 @@ public interface SyncSession extends Session {
/**
* Gets a document.
*
- * @param id The id of the document to get.
- * @return The known document having this id, or null if there is no
- * document having this id.
- * @throws UnsupportedOperationException Thrown if this access does not
- * support retrieving.
+ * @param id the id of the document to get.
+ * @return the known document having this id, or null if there is no document having this id
+ * @throws UnsupportedOperationException thrown if this access does not support retrieving
*/
default Document get(DocumentId id) { return get(id, null); }
@@ -64,8 +62,8 @@ public interface SyncSession extends Session {
/**
* Gets a document with timeout.
*
- * @param id The id of the document to get
- * @param timeout Timeout. If timeout is null, an unspecified default will be used
+ * @param id the id of the document to get
+ * @param timeout timeout. If timeout is null, an unspecified default will be used
* @return the document with this id, or null if there is none
* @throws UnsupportedOperationException thrown if this access does not support retrieving
* @throws DocumentAccessException on any messagebus error, including timeout ({@link com.yahoo.messagebus.ErrorCode#TIMEOUT}).
@@ -75,53 +73,50 @@ public interface SyncSession extends Session {
/**
* Gets a document with timeout.
*
- * @param id The id of the document to get.
- * @param fieldSet A comma-separated list of fields to retrieve
- * @param priority The priority with which to perform this operation.
- * @param timeout Timeout. If timeout is null, an unspecified default will be used.
- * @return The known document having this id, or null if there is no
- * document having this id.
- * @throws UnsupportedOperationException Thrown if this access does not support retrieving.
- * @throws DocumentAccessException on any messagebus error, including timeout ({@link com.yahoo.messagebus.ErrorCode#TIMEOUT}).
+ * @param id the id of the document to get
+ * @param fieldSet a comma-separated list of fields to retrieve
+ * @param priority the priority with which to perform this operation
+ * @param timeout timeout. If timeout is null, an unspecified default will be used
+ * @return the known document having this id, or null if there is no document having this id
+ * @throws UnsupportedOperationException thrown if this access does not support retrieving
+ * @throws DocumentAccessException on any messagebus error, including timeout ({@link com.yahoo.messagebus.ErrorCode#TIMEOUT})
*/
Document get(DocumentId id, String fieldSet, DocumentProtocol.Priority priority, Duration timeout);
/**
- * <p>Removes a document if it is present and condition is fulfilled.</p>
+ * Removes a document if it is present and condition is fulfilled.
+ *
* @param documentRemove document to delete
- * @return true if the document with this id was removed, false otherwise.
+ * @return true if the document with this id was removed, false otherwise
*/
boolean remove(DocumentRemove documentRemove);
/**
* Removes a document if it is present.
*
- * @param documentRemove Document remove operation
- * @param priority The priority with which to perform this operation.
- * @return true If the document with this id was removed, false otherwise.
- * @throws UnsupportedOperationException Thrown if this access does not
- * support removal.
+ * @param documentRemove document remove operation
+ * @param priority the priority with which to perform this operation
+ * @return true if the document with this id was removed, false otherwise.
+ * @throws UnsupportedOperationException thrown if this access does not support removal
*/
boolean remove(DocumentRemove documentRemove, DocumentProtocol.Priority priority);
/**
* Updates a document.
*
- * @param update The updates to perform.
- * @return True, if the document was found and updated.
- * @throws UnsupportedOperationException Thrown if this access does not
- * support update.
+ * @param update the updates to perform
+ * @return true, if the document was found and updated
+ * @throws UnsupportedOperationException thrown if this access does not support update
*/
boolean update(DocumentUpdate update);
/**
* Updates a document.
*
- * @param update The updates to perform.
- * @param priority The priority with which to perform this operation.
- * @return True, if the document was found and updated.
- * @throws UnsupportedOperationException Thrown if this access does not
- * support update.
+ * @param update the updates to perform.
+ * @param priority the priority with which to perform this operation
+ * @return true, if the document was found and updated
+ * @throws UnsupportedOperationException thrown if this access does not support update
*/
boolean update(DocumentUpdate update, DocumentProtocol.Priority priority);