org.eclipse.ditto.wot.model.ThingDescription 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.

There is a newer version: 3.6.0

/*
 * 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 org.eclipse.ditto.json.JsonObject;

/**
 * The WoT Thing Description (TD) is a central building block in the W3C Web of Things (WoT) and can be considered as
 * the entry point of a Thing.
 *
 * @see WoT TD Thing Description
 * @since 2.4.0
 */
public interface ThingDescription extends ThingSkeleton {

    static ThingDescription fromJson(final JsonObject jsonObject) {
        return new ImmutableThingDescription(jsonObject);
    }

    static ThingDescription.Builder newBuilder() {
        return ThingDescription.Builder.newBuilder();
    }

    static ThingDescription.Builder newBuilder(final JsonObject jsonObject) {
        return ThingDescription.Builder.newBuilder(jsonObject);
    }

    @Override
    default ThingDescription.Builder toBuilder() {
        return Builder.newBuilder(toJson());
    }

    interface Builder extends ThingSkeletonBuilder {

        static Builder newBuilder() {
            return new MutableThingDescriptionBuilder(JsonObject.newBuilder());
        }

        static Builder newBuilder(final JsonObject jsonObject) {
            return new MutableThingDescriptionBuilder(jsonObject.toBuilder());
        }
    }
}