• Home
• org.eclipse.ditto
• ditto-wot-model
• 3.6.0
• source code
• Interaction.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 * 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.Optional;

import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import org.eclipse.ditto.base.model.json.Jsonifiable;
import org.eclipse.ditto.json.JsonArray;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonObject;

/**
 * An Interaction describes how to interact with a Thing.
 * W3C WoT defines three types of Interaction Affordances: {@link Property}s, {@link Action}s, and {@link Event}s.
 *
 * @see WoT TD InteractionAffordance
 * @param  the type of the Interaction.
 * @param  the type of the Interaction's Forms.
 * @param  the type of the Interaction's Form's FormElements.
 * @since 2.4.0
 */
public interface Interaction, E extends FormElement, F extends Forms>
        extends TypedJsonObject, Jsonifiable {

    Optional getAtType();

    Optional getDescription();

    Optional getDescriptions();

    Optional