org.eclipse.ditto.wot.model.SingleRootFormElementOp 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 static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;

import java.util.Arrays;
import java.util.Optional;

/**
 * A SingleRootFormElementOp is a single {@link FormElementOp operation} ({@code op}) which can be defined within a
 * {@link RootFormElement} being part of a root level form.
 *
 * @since 2.4.0
 */
public enum SingleRootFormElementOp implements RootFormElementOp, CharSequence {
    READALLPROPERTIES("readallproperties"),
    WRITEALLPROPERTIES("writeallproperties"),
    READMULTIPLEPROPERTIES("readmultipleproperties"),
    WRITEMULTIPLEPROPERTIES("writemultipleproperties"),
    OBSERVEALLPROPERTIES("observeallproperties"),
    UNOBSERVEALLPROPERTIES("unobserveallproperties"),
    QUERYALLACTIONS("queryallactions"),
    SUBSCRIBEALLEVENTS("subscribeallevents"),
    UNSUBSCRIBEALLEVENTS("unsubscribeallevents");

    private final String name;

    SingleRootFormElementOp(final String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }

    /**
     * Returns the {@code SingleRootFormElementOp} for the given {@code name} if it exists.
     *
     * @param name the name.
     * @return the SingleRootFormElementOp or an empty optional.
     */
    public static Optional forName(final CharSequence name) {
        checkNotNull(name, "name");
        return Arrays.stream(values())
                .filter(c -> c.name.contentEquals(name))
                .findFirst();
    }

    @Override
    public int length() {
        return name.length();
    }

    @Override
    public char charAt(final int index) {
        return name.charAt(index);
    }

    @Override
    public CharSequence subSequence(final int start, final int end) {
        return name.subSequence(start, end);
    }

    @Override
    public String toString() {
        return name;
    }

}