Rename ESBytesRef to XBytesRef

Author: jordan-powers

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/json/ESJsonFactory.java

@@ -26,7 +26,6 @@ public class ESJsonFactory extends JsonFactory {
 
     @Override
     protected JsonParser _createParser(byte[] data, int offset, int len, IOContext ctxt) throws IOException {
-
         if (len > 0
             && Feature.CHARSET_DETECTION.enabledIn(_factoryFeatures)
             && Feature.CANONICALIZE_FIELD_NAMES.enabledIn(_factoryFeatures)) {
@@ -35,6 +34,7 @@ protected JsonParser _createParser(byte[] data, int offset, int len, IOContext c
             if (encoding == JsonEncoding.UTF8) {
                 boolean invalidBom = false;
                 int ptr = offset;
+                // Skip over the BOM if present
                 if ((data[ptr] & 0xFF) == 0xEF) {
                     if (len < 3) {
                         invalidBom = true;

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/json/ESJsonFactoryBuilder.java

@@ -15,7 +15,6 @@
 public class ESJsonFactoryBuilder extends JsonFactoryBuilder {
     @Override
     public JsonFactory build() {
-        // 28-Dec-2017, tatu: No special settings beyond base class ones, so:
         return new ESJsonFactory(this);
     }
 }

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/json/ESUTF8StreamJsonParser.java

@@ -16,7 +16,7 @@
 import com.fasterxml.jackson.core.json.UTF8StreamJsonParser;
 import com.fasterxml.jackson.core.sym.ByteQuadsCanonicalizer;
 
-import org.elasticsearch.xcontent.ESBytesRef;
+import org.elasticsearch.xcontent.XBytesRef;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -44,17 +44,17 @@ public ESUTF8StreamJsonParser(
      * This is only a best-effort attempt; if there is some reason the bytes cannot be retrieved, this method will return null.
      * Currently, this is only implemented for ascii-only strings that do not contain escaped characters.
      */
-    public ESBytesRef getValueAsByteRef() throws IOException {
+    public XBytesRef getValueAsByteRef() throws IOException {
         if (_currToken == JsonToken.VALUE_STRING && _tokenIncomplete) {
             if (stringEnd > 0) {
-                return new ESBytesRef(_inputBuffer, _inputPtr, stringEnd - 1);
+                return new XBytesRef(_inputBuffer, _inputPtr, stringEnd - 1);
             }
             return _finishAndReturnByteRef();
         }
         return null;
     }
 
-    protected ESBytesRef _finishAndReturnByteRef() throws IOException {
+    protected XBytesRef _finishAndReturnByteRef() throws IOException {
         int ptr = _inputPtr;
         if (ptr >= _inputEnd) {
             _loadMoreGuaranteed();
@@ -70,7 +70,7 @@ protected ESBytesRef _finishAndReturnByteRef() throws IOException {
             if (codes[c] != 0) {
                 if (c == INT_QUOTE) {
                     stringEnd = ptr + 1;
-                    return new ESBytesRef(inputBuffer, startPtr, ptr);
+                    return new XBytesRef(inputBuffer, startPtr, ptr);
                 }
                 return null;
             }

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/json/JsonXContentParser.java

@@ -18,7 +18,7 @@
 import com.fasterxml.jackson.core.io.JsonEOFException;
 
 import org.elasticsearch.core.IOUtils;
-import org.elasticsearch.xcontent.ESBytesRef;
+import org.elasticsearch.xcontent.XBytesRef;
 import org.elasticsearch.xcontent.XContentEOFException;
 import org.elasticsearch.xcontent.XContentLocation;
 import org.elasticsearch.xcontent.XContentParseException;
@@ -117,7 +117,7 @@ public String text() throws IOException {
     }
 
     @Override
-    public ESBytesRef textRefOrNull() throws IOException {
+    public XBytesRef textRefOrNull() throws IOException {
         if (currentToken().isValue() == false) {
             return null;
         }

libs/x-content/src/main/java/org/elasticsearch/xcontent/FilterXContentParser.java

@@ -101,7 +101,7 @@ public String textOrNull() throws IOException {
     }
 
     @Override
-    public ESBytesRef textRefOrNull() throws IOException {
+    public XBytesRef textRefOrNull() throws IOException {
         return delegate().textRefOrNull();
     }
 

libs/x-content/src/main/java/org/elasticsearch/xcontent/ESBytesRef.java renamed to libs/x-content/src/main/java/org/elasticsearch/xcontent/XBytesRef.java

@@ -9,4 +9,4 @@
 
 package org.elasticsearch.xcontent;
 
-public record ESBytesRef(byte[] bytes, int start, int end) {}
+public record XBytesRef(byte[] bytes, int start, int end) {}

libs/x-content/src/main/java/org/elasticsearch/xcontent/XContentParser.java

@@ -109,7 +109,12 @@ <T> Map<String, T> map(Supplier<Map<String, T>> mapFactory, CheckedFunction<XCon
 
     String textOrNull() throws IOException;
 
-    default ESBytesRef textRefOrNull() throws IOException {
+    /**
+     * Returns a {@link XBytesRef} containing UTF-8 bytes, if possible.
+     * This is only a best-effort attempt; if there is some reason the bytes cannot be retrieved, this method will return null.
+     * In this case, use {@link #textOrNull()} to get the string-encoded value.
+     */
+    default XBytesRef textRefOrNull() throws IOException {
         return null;
     }
 

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

@@ -30,10 +30,10 @@
 import org.elasticsearch.search.suggest.completion.context.ContextMapping;
 import org.elasticsearch.search.suggest.completion.context.ContextMappings;
 import org.elasticsearch.xcontent.DeprecationHandler;
-import org.elasticsearch.xcontent.ESBytesRef;
 import org.elasticsearch.xcontent.FilterXContentParser;
 import org.elasticsearch.xcontent.NamedXContentRegistry;
 import org.elasticsearch.xcontent.ToXContent;
+import org.elasticsearch.xcontent.XBytesRef;
 import org.elasticsearch.xcontent.XContentLocation;
 import org.elasticsearch.xcontent.XContentParser;
 import org.elasticsearch.xcontent.XContentParser.NumberType;
@@ -709,7 +709,7 @@ public Token currentToken() {
         }
 
         @Override
-        public ESBytesRef textRefOrNull() throws IOException {
+        public XBytesRef textRefOrNull() throws IOException {
             if (parsingObject == false) {
                 return null;
             }

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

@@ -10,9 +10,9 @@
 package org.elasticsearch.index.mapper;
 
 import org.elasticsearch.core.CheckedFunction;
-import org.elasticsearch.xcontent.ESBytesRef;
 import org.elasticsearch.xcontent.FilterXContentParser;
 import org.elasticsearch.xcontent.FilterXContentParserWrapper;
+import org.elasticsearch.xcontent.XBytesRef;
 import org.elasticsearch.xcontent.XContentLocation;
 import org.elasticsearch.xcontent.XContentParser;
 import org.elasticsearch.xcontent.XContentSubParser;
@@ -381,7 +381,7 @@ public void skipChildren() throws IOException {
     }
 
     @Override
-    public ESBytesRef textRefOrNull() throws IOException {
+    public XBytesRef textRefOrNull() throws IOException {
         if (state == State.EXPANDING_START_OBJECT) {
             throw new IllegalStateException("Can't get text on a " + currentToken() + " at " + getTokenLocation());
         }