org.eclipse.ditto.internal.models.streaming.BatchedEntityIdWithRevisions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ditto-internal-models-streaming Show documentation
Eclipse Ditto is a framework for creating and managing digital twins in the IoT.
The newest version!
/*
 * Copyright (c) 2017 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.internal.models.streaming;

import static org.eclipse.ditto.base.model.json.JsonSchemaVersion.V_2;

import java.util.List;
import java.util.Objects;
import java.util.function.Function;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;

import org.eclipse.ditto.base.model.headers.WithManifest;
import org.eclipse.ditto.base.model.json.Jsonifiable;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.json.JsonArray;
import org.eclipse.ditto.json.JsonCollectors;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonObject;

/**
 * A list of {@code EntityIdWithRevision} batched together.
 */
@Immutable
public final class BatchedEntityIdWithRevisions>
        implements Jsonifiable, StreamingMessage, WithManifest {

    static final JsonFieldDefinition JSON_TYPE = Command.JsonFields.TYPE;

    static final JsonFieldDefinition JSON_ELEMENTS =
            JsonFactory.newJsonArrayFieldDefinition("elements", V_2);

    private final String type;
    private final List elements;

    private BatchedEntityIdWithRevisions(final String type, final List elements) {
        this.type = type;
        this.elements = elements;
    }

    /**
     * Create a {@code BatchedEntityIdWithRevisions} object.
     *
     * @param  type of the elements.
     * @param elementClass class of the elements.
     * @param elements the batched elements.
     * @return a new {@code BatchedEntityIdWithRevisions} object.
     */
    public static > BatchedEntityIdWithRevisions of(final Class elementClass,
            final List elements) {
        return new BatchedEntityIdWithRevisions<>(typeOf(elementClass), elements);
    }

    /**
     * Create a type name for the JSON deserializer based on the type of elements.
     *
     * @param  type of the elements.
     * @param elementClass class of the elements.
     * @return type name of {@code BatchedEntityIdWithRevisions} with elements of type {@code T}.
     */
    public static > String typeOf(final Class elementClass) {
        return TYPE_PREFIX + "batched" + elementClass.getSimpleName();
    }

    /**
     * Create a deserializer from a deserializer of the elements.
     *
     * @param  type of the elements.
     * @param elementDeserializer deserializer for the elements.
     * @return deserializer for {@code BatchedEntityIdWithRevisions} with elements of type {@code T}.
     */
    public static > Function> deserializer(
            final Function elementDeserializer) {
        return jsonObject -> {
            final String type = jsonObject.getValueOrThrow(JSON_TYPE);
            final JsonArray jsonArray = jsonObject.getValueOrThrow(JSON_ELEMENTS);
            final List elements = jsonArray.stream()
                    .map(jsonValue -> elementDeserializer.apply(jsonValue.asObject()))
                    .toList();
            return new BatchedEntityIdWithRevisions<>(type, elements);
        };
    }

    /**
     * Retrieve the elements.
     *
     * @return the elements.
     */
    public List getElements() {
        return elements;
    }

    @Override
    public JsonObject toJson() {
        final JsonArray jsonArray = elements.stream().map(Jsonifiable::toJson).collect(JsonCollectors.valuesToArray());
        return JsonFactory.newObjectBuilder()
                .set(JSON_TYPE, type)
                .set(JSON_ELEMENTS, jsonArray)
                .build();
    }

    @Override
    public int hashCode() {
        return Objects.hash(type, elements);
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) {
            return true;
        } else if (obj == null || getClass() != obj.getClass()) {
            return false;
        } else {
            final BatchedEntityIdWithRevisions that = (BatchedEntityIdWithRevisions) obj;
            return Objects.equals(type, that.type) && Objects.equals(elements, that.elements);
        }
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + " [" + super.toString()
                + ", elements=" + elements
                + "]";
    }

    @Nonnull
    @Override
    public String getManifest() {
        return type;
    }
}