com.hivemq.adapter.sdk.api.ProtocolPublishResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-edge-adapter-sdk Show documentation

SDK for the development of HiveMQ Edge protocol adapters

The newest version!

/*
 * Copyright 2023-present HiveMQ GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.hivemq.adapter.sdk.api;

import org.jetbrains.annotations.NotNull;

public enum ProtocolPublishResult {

    /**
     * the MQTT publish was delivered.
     */
    DELIVERED(0),

    /**
     * the MQTT publish has no matching subscribers.
     */
    NO_MATCHING_SUBSCRIBERS(1),

    /**
     * the MQTT publish delivery failed
     */
    FAILED(2);

    private static final @NotNull ProtocolPublishResult @NotNull [] VALUES = values();

    private final int id;

    ProtocolPublishResult(final int id) {
        this.id = id;
    }

    public int getId() {
        return id;
    }

    public static @NotNull ProtocolPublishResult valueOf(final int i) {
        try {
            return VALUES[i];
        } catch (final ArrayIndexOutOfBoundsException e) {
            throw new IllegalArgumentException("No publish return code found for the given value : " + i + ".", e);
        }
    }
}