All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.elasticsearch.xcontent.XContentParser Maven / Gradle / Ivy

Go to download

Elasticsearch subproject :libs:elasticsearch-x-content

There is a newer version: 8.16.0
Show newest version
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.xcontent;

import org.elasticsearch.core.CheckedFunction;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.core.RestApiVersion;

import java.io.Closeable;
import java.io.IOException;
import java.nio.CharBuffer;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;

/**
 * Interface for pull - parsing {@link XContent} see {@link XContentType} for supported types.
 *
 * To obtain an instance of this class use the following pattern:
 *
 * 
 *     XContentType xContentType = XContentType.JSON;
 *     XContentParser parser = xContentType.xContent().createParser(
 *          NamedXContentRegistry.EMPTY, ParserField."{\"key\" : \"value\"}");
 * 

 */
public interface XContentParser extends Closeable {

    enum Token {
        START_OBJECT(false),
        END_OBJECT(false),
        START_ARRAY(false),
        END_ARRAY(false),
        FIELD_NAME(false),
        VALUE_STRING(true),
        VALUE_NUMBER(true),
        VALUE_BOOLEAN(true),
        // usually a binary value
        VALUE_EMBEDDED_OBJECT(true),
        VALUE_NULL(false);

        private final boolean isValue;

        Token(boolean isValue) {
            this.isValue = isValue;
        }

        public boolean isValue() {
            return isValue;
        }
    }

    enum NumberType {
        INT,
        BIG_INTEGER,
        LONG,
        FLOAT,
        DOUBLE,
        BIG_DECIMAL
    }

    XContentType contentType();

    void allowDuplicateKeys(boolean allowDuplicateKeys);

    Token nextToken() throws IOException;

    @Nullable
    default String nextFieldName() throws IOException {
        return nextToken() == Token.FIELD_NAME ? currentName() : null;
    }

    void skipChildren() throws IOException;

    Token currentToken();

    String currentName() throws IOException;

    Map map() throws IOException;

    Map mapOrdered() throws IOException;

    Map mapStrings() throws IOException;

    /**
     * Returns an instance of {@link Map} holding parsed map.
     * Serves as a replacement for the "map", "mapOrdered" and "mapStrings" methods above.
     *
     * @param mapFactory factory for creating new {@link Map} objects
     * @param mapValueParser parser for parsing a single map value
     * @param  map value type
     * @return {@link Map} object
     */
     Map map(Supplier> mapFactory, CheckedFunction mapValueParser)
        throws IOException;

    List list() throws IOException;

    List listOrderedMap() throws IOException;

    String text() throws IOException;

    String textOrNull() throws IOException;

    CharBuffer charBufferOrNull() throws IOException;

    /**
     * Returns a {@link CharBuffer} holding UTF-8 bytes.
     * This method should be used to read text only binary content should be read through {@link #binaryValue()}
     */
    CharBuffer charBuffer() throws IOException;

    Object objectText() throws IOException;

    Object objectBytes() throws IOException;

    /**
     * Method that can be used to determine whether calling of textCharacters() would be the most efficient way to
     * access textual content for the event parser currently points to.
     *
     * Default implementation simply returns false since only actual
     * implementation class has knowledge of its internal buffering
     * state.
     *
     * This method shouldn't be used to check if the token contains text or not.
     */
    boolean hasTextCharacters();

    char[] textCharacters() throws IOException;

    int textLength() throws IOException;

    int textOffset() throws IOException;

    Number numberValue() throws IOException;

    NumberType numberType() throws IOException;

    short shortValue(boolean coerce) throws IOException;

    int intValue(boolean coerce) throws IOException;

    long longValue(boolean coerce) throws IOException;

    float floatValue(boolean coerce) throws IOException;

    double doubleValue(boolean coerce) throws IOException;

    short shortValue() throws IOException;

    int intValue() throws IOException;

    long longValue() throws IOException;

    float floatValue() throws IOException;

    double doubleValue() throws IOException;

    /**
     * @return true iff the current value is either boolean (true or false) or one of "false", "true".
     */
    boolean isBooleanValue() throws IOException;

    boolean booleanValue() throws IOException;

    /**
     * Reads a plain binary value that was written via one of the following methods:
     *
     * 
    
     *     
  • {@link XContentBuilder#field(String, byte[], int, int)}}
    • 
     *     
  • {@link XContentBuilder#field(String, byte[])}}
    • 
     * 

     *
     * as well as via their String variants of the separated value methods.
     * Note: Do not use this method to read values written with:
     * 
    
     *     
  • {@link XContentBuilder#utf8Value(byte[], int, int)}
    • 
     * 

     *
     * these methods write UTF-8 encoded strings and must be read through:
     * 
    
     *     
  • {@link XContentParser#text()} ()}
    • 
     *     
  • {@link XContentParser#textOrNull()} ()}
    • 
     *     
  • {@link XContentParser#textCharacters()} ()}}
    • 
     * 

     *
     */
    byte[] binaryValue() throws IOException;

    /**
     * Used for error reporting to highlight where syntax errors occur in
     * content being parsed.
     *
     * @return last token's location or null if cannot be determined
     */
    XContentLocation getTokenLocation();

    // TODO remove context entirely when it isn't needed
    /**
     * Parse an object by name.
     */
     T namedObject(Class categoryClass, String name, Object context) throws IOException;

    /**
     * The registry used to resolve {@link #namedObject(Class, String, Object)}. Use this when building a sub-parser from this parser.
     */
    NamedXContentRegistry getXContentRegistry();

    boolean isClosed();

    RestApiVersion getRestApiVersion();

    /**
     * The callback to notify when parsing encounters a deprecated field.
     */
    DeprecationHandler getDeprecationHandler();
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy