Skip to content

Commit 86a1aa0

Browse files
committed
added more jdocs
1 parent 2a72a77 commit 86a1aa0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

server/src/main/java/org/elasticsearch/index/mapper/SortedSetWithOffsetsDocValuesSyntheticFieldLoaderLayer.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,22 @@ final class SortedSetWithOffsetsDocValuesSyntheticFieldLoaderLayer implements Co
3434
private final Function<BytesRef, BytesRef> converter;
3535
private DocValuesWithOffsetsLoader docValues;
3636

37+
/**
38+
* @param name The name of the field to synthesize
39+
* @param offsetsFieldName The related offset field used to correctly synthesize the field if it is a leaf array
40+
*/
3741
SortedSetWithOffsetsDocValuesSyntheticFieldLoaderLayer(String name, String offsetsFieldName) {
3842
this(name, offsetsFieldName, Function.identity());
3943
}
4044

45+
/**
46+
* @param name The name of the field to synthesize
47+
* @param offsetsFieldName The related offset field used to correctly synthesize the field if it is a leaf array
48+
* @param converter This field value loader layer synthesizes the values read from doc values as utf8 string. If the doc value
49+
* values aren't serializable as utf8 string then it is the responsibility of the converter to covert into a
50+
* format that can be serialized as utf8 string. For example IP field mapper doc values can't directly be
51+
* serialized as utf8 string.
52+
*/
4153
SortedSetWithOffsetsDocValuesSyntheticFieldLoaderLayer(String name, String offsetsFieldName, Function<BytesRef, BytesRef> converter) {
4254
this.name = Objects.requireNonNull(name);
4355
this.offsetsFieldName = Objects.requireNonNull(offsetsFieldName);

0 commit comments

Comments
 (0)