• Home
• org.eclipse.ditto
• ditto-wot-model
• 3.6.1
• source code
• FormElement.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.FormElement 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;

/**
 * A FormElement is a "hypermedia control that describe how an operation can be performed".
 *
 * @see WoT TD Form
 * @see WoT TD Form serialization as JSON
 * @param  the type of the FormElement.
 * @since 2.4.0
 */
public interface FormElement> extends TypedJsonObject, Jsonifiable {

    IRI getHref();

    String getContentType();

    Optional getContentCoding();

    Optional getSubprotocol();

    Optional getSecurity();

    Optional getScopes();

    Optional getExpectedResponse();

    Optional getAdditionalResponses();

    interface Builder, E extends FormElement>
            extends TypedJsonObjectBuilder {

        B setHref(@Nullable IRI href);

        B setContentType(@Nullable String contentType);

        B setContentCoding(@Nullable String contentCoding);

        B setSubprotocol(@Nullable String subprotocol);

        B setSecurity(@Nullable Security security);

        B setScopes(@Nullable OAuth2Scopes scopes);

        B setExpectedResponse(@Nullable FormElementExpectedResponse expectedResponse);

        B setAdditionalResponses(@Nullable FormElementAdditionalResponses additionalResponses);

    }

    /**
     * An enumeration of the known {@link JsonFieldDefinition}s of a FormElement.
     */
    @Immutable
    final class JsonFields {

        public static final JsonFieldDefinition OP = JsonFactory.newStringFieldDefinition(
                "op");

        public static final JsonFieldDefinition OP_MULTIPLE = JsonFactory.newJsonArrayFieldDefinition(
                "op");

        public static final JsonFieldDefinition HREF = JsonFactory.newStringFieldDefinition(
                "href");

        public static final JsonFieldDefinition CONTENT_TYPE = JsonFactory.newStringFieldDefinition(
                "contentType");

        public static final JsonFieldDefinition CONTENT_CODING = JsonFactory.newStringFieldDefinition(
                "contentCoding");

        public static final JsonFieldDefinition SUBPROTOCOL = JsonFactory.newStringFieldDefinition(
                "subprotocol");

        public static final JsonFieldDefinition SECURITY = JsonFactory.newStringFieldDefinition(
                "security");

        public static final JsonFieldDefinition SECURITY_MULTIPLE = JsonFactory.newJsonArrayFieldDefinition(
                "security");

        public static final JsonFieldDefinition SCOPES = JsonFactory.newStringFieldDefinition(
                "scopes");

        public static final JsonFieldDefinition SCOPES_MULTIPLE = JsonFactory.newJsonArrayFieldDefinition(
                "scopes");

        public static final JsonFieldDefinition RESPONSE = JsonFactory.newJsonObjectFieldDefinition(
                "response");

        public static final JsonFieldDefinition ADDITIONAL_RESPONSES =
                JsonFactory.newJsonArrayFieldDefinition(
                        "additionalResponses");

        private JsonFields() {
            throw new AssertionError();
        }
    }
}