co.elastic.clients.transport.endpoints.DictionaryResponse Maven / Gradle / Ivy

Go to download
/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package co.elastic.clients.transport.endpoints;

import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpSerializer;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;

import javax.annotation.Nullable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * Base class for dictionary responses, i.e. a series of key/value pairs.
 */
public abstract class DictionaryResponse implements JsonpSerializable {
    private final Map result;

    @Nullable
    private final JsonpSerializer tKeySerializer;

    @Nullable
    private final JsonpSerializer tValueSerializer;

    // ---------------------------------------------------------------------------------------------

    protected DictionaryResponse(AbstractBuilder builder) {

        this.result = builder.result;
        this.tKeySerializer = builder.tKeySerializer;
        this.tValueSerializer = builder.tValueSerializer;

    }

    /**
     * Returns the response as a map.
     */
    public Map result() {
        return this.result == null ? Collections.emptyMap() : result;
    }

    /**
     *
     */
    public TValue get(String key) {
        return this.result == null ? null : result.get(key);
    }

    /**
     * Serialize this value to JSON.
     */
    public void serialize(JsonGenerator generator, JsonpMapper mapper) {
        generator.writeStartObject();
        this.serializeInternal(generator, mapper);
        generator.writeEnd();
    }

    protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
        for (Map.Entry item0 : this.result.entrySet()) {
            generator.writeKey(item0.getKey());
            JsonpUtils.serialize(item0.getValue(), generator, tValueSerializer, mapper);
        }
    }

    @Override
    public String toString() {
        return JsonpUtils.toString(this);
    }

    protected abstract static class AbstractBuilder>
        extends ObjectBuilderBase {

        private Map result;

        @Nullable
        private JsonpSerializer tKeySerializer;

        @Nullable
        private JsonpSerializer tValueSerializer;

        /**
         * Response result.
         */
        public BuilderT result(Map value) {
            this.result = value;
            return self();
        }

        /**
         * Add a key/value to {@link #result(Map)}, creating the map if needed.
         */
        public BuilderT putResult(String key, TValue value) {
            if (this.result == null) {
                this.result = new HashMap<>();
            }
            this.result.put(key, value);
            return self();
        }

        /**
         * Serializer for TKey. If not set, an attempt will be made to find a serializer
         * from the JSON context.
         *
         */
        public BuilderT tKeySerializer(@Nullable JsonpSerializer value) {
            this.tKeySerializer = value;
            return self();
        }

        /**
         * Serializer for TValue. If not set, an attempt will be made to find a
         * serializer from the JSON context.
         *
         */
        public BuilderT tValueSerializer(@Nullable JsonpSerializer value) {
            this.tValueSerializer = value;
            return self();
        }

        protected abstract BuilderT self();

    }

    // ---------------------------------------------------------------------------------------------
    protected static > void setupDictionaryResponseDeserializer(
        ObjectDeserializer op, JsonpDeserializer tKeyParser,
        JsonpDeserializer tValueParser) {

        op.setUnknownFieldHandler((builder, name, parser, params) -> {
            builder.putResult(name, tValueParser.deserialize(parser, params));
        });
    }
}