org.eclipse.ditto.wot.model.TmOptional Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ditto-wot-model Show documentation

Eclipse Ditto is a framework for creating and managing digital twins in the IoT.

The newest version!

/*
 * Copyright (c) 2022 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.wot.model;

import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

import org.eclipse.ditto.base.model.json.Jsonifiable;
import org.eclipse.ditto.json.JsonArray;
import org.eclipse.ditto.json.JsonValue;

/**
 * TmOptional holds which parts in a {@link ThingModel} are optionally implemented in a {@link ThingDescription}
 * derived from the Thing Model.
 *
 * @see WoT TD Thing Model Optional
 * @since 3.0.0
 */
public interface TmOptional extends Iterable, Jsonifiable {

    static TmOptional fromJson(final JsonArray jsonArray) {
        final List optionalElements = jsonArray.stream()
                .filter(JsonValue::isString)
                .map(JsonValue::asString)
                .map(TmOptionalElement::of)
                .collect(Collectors.toList());
        return of(optionalElements);
    }

    static TmOptional of(final Collection optionalElements) {
        return new ImmutableTmOptional(optionalElements);
    }

    default Stream stream() {
        return StreamSupport.stream(spliterator(), false);
    }
}