com.hivemq.client.internal.mqtt.message.subscribe.MqttSubscriptionBuilder 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
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.internal.mqtt.message.subscribe;
import com.hivemq.client.internal.mqtt.datatypes.MqttTopicFilterImpl;
import com.hivemq.client.internal.mqtt.datatypes.MqttTopicFilterImplBuilder;
import com.hivemq.client.internal.mqtt.util.MqttChecks;
import com.hivemq.client.internal.util.Checks;
import com.hivemq.client.mqtt.datatypes.MqttQos;
import com.hivemq.client.mqtt.datatypes.MqttTopicFilter;
import com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5RetainHandling;
import com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5Subscription;
import com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5SubscriptionBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.function.Function;
/**
* @author Silvio Giebl
*/
public abstract class MqttSubscriptionBuilder> {
private @Nullable MqttTopicFilterImpl topicFilter;
private @NotNull MqttQos qos = MqttSubscription.DEFAULT_QOS;
private boolean noLocal = MqttSubscription.DEFAULT_NO_LOCAL;
private @NotNull Mqtt5RetainHandling retainHandling = MqttSubscription.DEFAULT_RETAIN_HANDLING;
private boolean retainAsPublished = MqttSubscription.DEFAULT_RETAIN_AS_PUBLISHED;
MqttSubscriptionBuilder() {}
MqttSubscriptionBuilder(final @NotNull MqttSubscription subscription) {
topicFilter = subscription.getTopicFilter();
qos = subscription.getQos();
noLocal = subscription.isNoLocal();
retainHandling = subscription.getRetainHandling();
retainAsPublished = subscription.isRetainAsPublished();
}
abstract @NotNull B self();
public @NotNull B topicFilter(final @Nullable String topicFilter) {
this.topicFilter = MqttTopicFilterImpl.of(topicFilter);
return self();
}
public @NotNull B topicFilter(final @Nullable MqttTopicFilter topicFilter) {
this.topicFilter = MqttChecks.topicFilter(topicFilter);
return self();
}
public MqttTopicFilterImplBuilder.@NotNull Nested topicFilter() {
return new MqttTopicFilterImplBuilder.Nested<>(this::topicFilter);
}
public @NotNull B qos(final @Nullable MqttQos qos) {
this.qos = Checks.notNull(qos, "QoS");
return self();
}
public @NotNull B noLocal(final boolean noLocal) {
this.noLocal = noLocal;
return self();
}
public @NotNull B retainHandling(final @Nullable Mqtt5RetainHandling retainHandling) {
this.retainHandling = Checks.notNull(retainHandling, "Retain handling");
return self();
}
public @NotNull B retainAsPublished(final boolean retainAsPublished) {
this.retainAsPublished = retainAsPublished;
return self();
}
public @NotNull MqttSubscription build() {
Checks.notNull(topicFilter, "Topic filter");
Checks.state(
!(topicFilter.isShared() && noLocal),
"It is a Protocol Error to set no local to true on a Shared Subscription.");
return new MqttSubscription(topicFilter, qos, noLocal, retainHandling, retainAsPublished);
}
public static class Default extends MqttSubscriptionBuilder implements Mqtt5SubscriptionBuilder.Complete {
public Default() {}
Default(final @NotNull MqttSubscription subscription) {
super(subscription);
}
@Override
@NotNull Default self() {
return this;
}
}
public static class Nested extends MqttSubscriptionBuilder>
implements Mqtt5SubscriptionBuilder.Nested.Complete {
private final @NotNull Function parentConsumer;
public Nested(final @NotNull Function parentConsumer) {
this.parentConsumer = parentConsumer;
}
@Override
@NotNull Nested
self() {
return this;
}
@Override
public @NotNull P applySubscription() {
return parentConsumer.apply(build());
}
}
}