aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java
diff options
context:
space:
mode:
authorJon Bratseth <bratseth@verizonmedia.com>2019-10-11 10:11:54 +0200
committerJon Bratseth <bratseth@verizonmedia.com>2019-10-11 10:11:54 +0200
commitf5b19f08303bc1222c15168a1242f3ad6a4027f0 (patch)
tree5ee5573c5d1504b4e91a6b39976b61db316ff003 /container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java
parentf9fa61babcf9a510d7d2fb073a230dec737ed41b (diff)
Improve javadoc
Diffstat (limited to 'container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java')
-rw-r--r--container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java19
1 files changed, 7 insertions, 12 deletions
diff --git a/container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java b/container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java
index bd27fd4f738..c0bea7003c0 100644
--- a/container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java
+++ b/container-search/src/main/java/com/yahoo/search/grouping/request/StringBucket.java
@@ -8,12 +8,7 @@ package com.yahoo.search.grouping.request;
*/
public class StringBucket extends BucketValue {
- /**
- * Get the next distinct value.
- *
- * @param value the base value
- * @return the next value
- */
+ /** Returns the next distinct value after the given value */
public static StringValue nextValue(StringValue value) {
return new StringValue(value.getValue() + " ");
}
@@ -29,20 +24,20 @@ public class StringBucket extends BucketValue {
}
/**
- * Constructs a new instance of this class.
+ * Constructs a new bucket for a range of strings.
*
- * @param from the from-value to assign to this
- * @param to the to-value to assign to this
+ * @param from the start of the bucket, inclusive
+ * @param to the end of the bucket, exclusive
*/
public StringBucket(String from, String to) {
super(null, null, new StringValue(from), new StringValue(to));
}
/**
- * Constructs a new instance of this class.
+ * Constructs a new bucket for a range of strings.
*
- * @param from the from-value to assign to this
- * @param to the to-value to assign to this
+ * @param from the start of the bucket, inclusive
+ * @param to the end of the bucket, exclusive
*/
public StringBucket(ConstantValue<?> from, ConstantValue<?> to) {
super(null, null, from, to);