com.hivemq.client.mqtt.mqtt5.message.publish.Mqtt5PublishBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-mqtt-client Show documentation
HiveMQ MQTT Client is an MQTT 5.0 and MQTT 3.1.1 compatible and feature-rich high-performance Java client library with different API flavours and backpressure support
The newest version!
/*
 * Copyright 2018-present HiveMQ and the HiveMQ Community
 *
 * 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.client.mqtt.mqtt5.message.publish;

import com.hivemq.client.annotations.CheckReturnValue;
import com.hivemq.client.annotations.DoNotImplement;
import org.jetbrains.annotations.NotNull;

/**
 * Builder for a {@link Mqtt5Publish}.
 *
 * @author Silvio Giebl
 * @since 1.0
 */
@DoNotImplement
public interface Mqtt5PublishBuilder extends Mqtt5PublishBuilderBase {

    /**
     * Creates a builder for a {@link Mqtt5WillPublish} that extends the current Publish message of this builder.
     *
     * @return the created builder for a Will Publish.
     */
    @CheckReturnValue
    @NotNull Mqtt5WillPublishBuilder asWill();

    /**
     * {@link Mqtt5PublishBuilder} that is complete which means all mandatory fields are set.
     */
    @DoNotImplement
    interface Complete extends Mqtt5PublishBuilder, Mqtt5PublishBuilderBase.Complete {

        /**
         * Creates a builder for a {@link Mqtt5WillPublish} that extends the current Publish message of this builder.
         *
         * @return the created complete builder for a Will Publish.
         */
        @Override
        @CheckReturnValue
        Mqtt5WillPublishBuilder.@NotNull Complete asWill();

        /**
         * Builds the {@link Mqtt5Publish}.
         *
         * @return the built {@link Mqtt5Publish}.
         */
        @CheckReturnValue
        @NotNull Mqtt5Publish build();
    }

    /**
     * Builder for a {@link Mqtt5Publish} that is applied to a parent {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client}
     * which then sends the Publish message.
     *
     * @param  the type of the result when the built {@link Mqtt5Publish} is sent by the parent.
     */
    @DoNotImplement
    interface Nested
 extends Mqtt5PublishBuilderBase> {

        /**
         * {@link Nested} that is complete which means all mandatory fields are set.
         *
         * @param 
 the type of the result when the built {@link Mqtt5Publish} is applied to the parent.
         */
        @DoNotImplement
        interface Complete
 extends Nested
, Mqtt5PublishBuilderBase.Complete> {

            /**
             * Builds the {@link Mqtt5Publish} and applies it to the parent.
             *
             * @return the result when the built {@link Mqtt5Publish} is applied to the parent.
             */
            @NotNull P applyPublish();
        }
    }

    /**
     * Builder for a {@link Mqtt5Publish} that is applied to a parent {@link com.hivemq.client.mqtt.mqtt5.Mqtt5Client}
     * which then sends the Publish message without returning a result.
     */
    @DoNotImplement
    interface Send
 extends Mqtt5PublishBuilderBase> {

        /**
         * {@link Send} that is complete which means all mandatory fields are set.
         *
         * @param 
 the type of the result when the built {@link Mqtt5Publish} is sent by the parent.
         */
        @DoNotImplement
        interface Complete
 extends Send, Mqtt5PublishBuilderBase.Complete> {

            /**
             * Builds the {@link Mqtt5Publish} and applies it to the parent which then sends the Publish message.
             *
             * @return the result when the built {@link Mqtt5Publish} is sent by the parent.
             */
            @NotNull P send();
        }
    }
}