summaryrefslogtreecommitdiffstats
path: root/documentapi
diff options
context:
space:
mode:
authorJon Bratseth <bratseth@verizonmedia.com>2019-07-28 19:51:08 +0200
committerJon Bratseth <bratseth@verizonmedia.com>2019-07-28 19:51:08 +0200
commita1c2cbf49a076bd659eb439da0c0298edc8fe224 (patch)
tree2f4fa936bf95a32f9c183e6ffcb432caa32e7973 /documentapi
parent50603040c505026b1431359016704b4f10e302f1 (diff)
Rename constant dimensions
Diffstat (limited to 'documentapi')
-rwxr-xr-xdocumentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java3
-rwxr-xr-xdocumentapi/src/main/java/com/yahoo/documentapi/SyncSession.java21
2 files changed, 12 insertions, 12 deletions
diff --git a/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java b/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java
index acf027dd0aa..29d04c85a05 100755
--- a/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java
+++ b/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java
@@ -11,6 +11,7 @@ import java.util.Optional;
* @author Simon Thoresen Hult
*/
public class SyncParameters extends Parameters {
+
private final Duration defaultTimeout;
private SyncParameters() {
@@ -26,6 +27,7 @@ public class SyncParameters extends Parameters {
}
public static class Builder {
+
private Duration defaultTimeout;
/**
@@ -39,4 +41,5 @@ public class SyncParameters extends Parameters {
return new SyncParameters(defaultTimeout);
}
}
+
}
diff --git a/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java b/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
index 418c0374193..6c4306b683c 100755
--- a/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
+++ b/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
@@ -51,13 +51,11 @@ public interface SyncSession extends Session {
/**
* Gets a document with an unspecified 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.
- * @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
+ * @param fieldSet a comma-separated list of fields to retrieve
+ * @param priority the priority with which to perform this operation
+ * @return the document with this id, or null if there is none
+ * @throws UnsupportedOperationException thrown if this does not support retrieving
*/
default Document get(DocumentId id, String fieldSet, DocumentProtocol.Priority priority) {
return get(id, fieldSet, priority, null);
@@ -66,11 +64,10 @@ 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.
- * @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
+ * @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}).
*/
Document get(DocumentId id, Duration timeout);