com.hivemq.client.mqtt.mqtt3.message.subscribe.Mqtt3SubscribeBuilder Maven / Gradle / Ivy
Show all versions of hivemq-mqtt-client Show documentation
/*
* 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.mqtt3.message.subscribe;
import com.hivemq.client.annotations.CheckReturnValue;
import com.hivemq.client.annotations.DoNotImplement;
import org.jetbrains.annotations.NotNull;
/**
* Builder for a {@link Mqtt3Subscribe}.
*
* @author Silvio Giebl
* @since 1.0
*/
@DoNotImplement
public interface Mqtt3SubscribeBuilder extends Mqtt3SubscribeBuilderBase {
/**
* {@link Mqtt3SubscribeBuilder} that is complete which means all mandatory fields are set.
*/
@DoNotImplement
interface Complete extends Mqtt3SubscribeBuilder, Mqtt3SubscribeBuilderBase {
/**
* Builds the {@link Mqtt3Subscribe}.
*
* @return the built {@link Mqtt3Subscribe}.
*/
@CheckReturnValue
@NotNull Mqtt3Subscribe build();
}
/**
* {@link Mqtt3SubscribeBuilder} that provides additional methods for the first subscription.
*/
@DoNotImplement
interface Start extends Mqtt3SubscribeBuilder,
Mqtt3SubscribeBuilderBase.Start {
/**
* {@link Mqtt3SubscribeBuilder.Start} that is complete which means all mandatory fields are set.
*/
// @formatter:off
@DoNotImplement
interface Complete extends Mqtt3SubscribeBuilder.Start, Mqtt3SubscribeBuilder.Complete,
Mqtt3SubscribeBuilderBase.Start.Complete<
Mqtt3SubscribeBuilder.Complete, Mqtt3SubscribeBuilder.Start.Complete> {}
// @formatter:on
}
/**
* Builder for a {@link Mqtt3Subscribe} that is applied to a parent.
*
* @param the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Nested
extends Mqtt3SubscribeBuilderBase> {
/**
* {@link Nested} that is complete which means all mandatory fields are set.
*
* @param the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Complete
extends Nested
, Mqtt3SubscribeBuilderBase> {
/**
* Builds the {@link Mqtt3Subscribe} and applies it to the parent.
*
* @return the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@NotNull P applySubscribe();
}
/**
* {@link Nested} that provides additional methods for the first subscription.
*
* @param the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Start
extends Nested
, Mqtt3SubscribeBuilderBase.Start, Nested.Start.Complete> {
/**
* {@link Nested.Start} that is complete which means all mandatory fields are set.
*
* @param
the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Complete
extends Nested.Start
, Nested.Complete
,
Mqtt3SubscribeBuilderBase.Start.Complete, Nested.Start.Complete> {}
}
}
/**
* Builder for a {@link Mqtt3Subscribe} that is applied to a parent {@link com.hivemq.client.mqtt.mqtt3.Mqtt3Client
* Mqtt3Client} which then sends the Subscribe message.
*
* @param
the type of the result when the built {@link Mqtt3Subscribe} is sent by the parent.
*/
@DoNotImplement
interface Send
extends Mqtt3SubscribeBuilderBase> {
/**
* {@link Send} that is complete which means all mandatory fields are set.
*
* @param the type of the result when the built {@link Mqtt3Subscribe} is sent by the parent.
*/
@DoNotImplement
interface Complete
extends Send
, Mqtt3SubscribeBuilderBase> {
/**
* Builds the {@link Mqtt3Subscribe} and applies it to the parent which then sends the Subscribe message.
*
* @return the result when the built {@link Mqtt3Subscribe} is sent by the parent.
*/
@NotNull P send();
}
/**
* {@link Send} that provides additional methods for the first subscription.
*
* @param the type of the result when the built {@link Mqtt3Subscribe} is sent by the parent.
*/
@DoNotImplement
interface Start
extends Send
, Mqtt3SubscribeBuilderBase.Start, Send.Start.Complete> {
/**
* {@link Send.Start} that is complete which means all mandatory fields are set.
*
* @param
the type of the result when the built {@link Mqtt3Subscribe} is sent by the parent.
*/
@DoNotImplement
interface Complete
extends Send.Start
, Send.Complete
,
Mqtt3SubscribeBuilderBase.Start.Complete, Send.Start.Complete> {}
}
}
/**
* Builder for a {@link Mqtt3Subscribe} and additional arguments that are applied to a parent {@link
* com.hivemq.client.mqtt.mqtt3.Mqtt3Client Mqtt3Client} subscribePublishes call.
*
* @param
the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
* @since 1.2
*/
@DoNotImplement
interface Publishes
extends Mqtt3SubscribeBuilderBase> {
/**
* {@link Publishes} that is complete which means all mandatory fields are set.
*
* @param the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Complete
extends Publishes
, Publishes.Args
, Mqtt3SubscribeBuilderBase> {}
/**
* {@link Publishes} that provides additional methods for the first subscription.
*
* @param the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Start
extends Publishes
,
Mqtt3SubscribeBuilderBase.Start, Publishes.Start.Complete> {
/**
* {@link Publishes.Start} that is complete which means all mandatory fields are set.
*
* @param
the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Complete
extends Publishes.Start
, Publishes.Complete
,
Mqtt3SubscribeBuilderBase.Start.Complete, Publishes.Start.Complete> {}
}
/**
* Builder for additional arguments alongside the {@link Mqtt3Subscribe} that are applied to a parent {@link
* com.hivemq.client.mqtt.mqtt3.Mqtt3Client Mqtt3Client} subscribePublishes call.
*
* @param
the type of the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@DoNotImplement
interface Args
{
/**
* Sets whether the matching Publish messages consumed via the subscriptions are acknowledged manually.
*
* @param manualAcknowledgement whether the matching Publish messages are acknowledged manually.
* @return the builder.
*/
@CheckReturnValue
@NotNull Args
manualAcknowledgement(boolean manualAcknowledgement);
/**
* Builds the {@link Mqtt3Subscribe} and applies it and additional arguments to the parent.
*
* @return the result when the built {@link Mqtt3Subscribe} is applied to the parent.
*/
@NotNull P applySubscribe();
}
}
}