com.hivemq.client.internal.mqtt.message.subscribe.MqttSubscribeBuilder 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.internal.mqtt.message.subscribe;
import com.hivemq.client.internal.mqtt.datatypes.MqttTopicFilterImplBuilder;
import com.hivemq.client.internal.mqtt.datatypes.MqttUserPropertiesImpl;
import com.hivemq.client.internal.mqtt.datatypes.MqttUserPropertiesImplBuilder;
import com.hivemq.client.internal.mqtt.util.MqttChecks;
import com.hivemq.client.internal.util.Checks;
import com.hivemq.client.internal.util.collections.ImmutableList;
import com.hivemq.client.mqtt.datatypes.MqttQos;
import com.hivemq.client.mqtt.datatypes.MqttTopicFilter;
import com.hivemq.client.mqtt.mqtt5.datatypes.Mqtt5UserProperties;
import com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5RetainHandling;
import com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5SubscribeBuilder;
import com.hivemq.client.mqtt.mqtt5.message.subscribe.Mqtt5Subscription;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collection;
import java.util.function.Function;
import java.util.stream.Stream;
/**
* @author Silvio Giebl
*/
public abstract class MqttSubscribeBuilder> {
private final ImmutableList.@NotNull Builder subscriptionsBuilder;
private @NotNull MqttUserPropertiesImpl userProperties = MqttUserPropertiesImpl.NO_USER_PROPERTIES;
private MqttSubscriptionBuilder.@Nullable Default firstSubscriptionBuilder;
protected MqttSubscribeBuilder() {
subscriptionsBuilder = ImmutableList.builder();
}
MqttSubscribeBuilder(final @NotNull MqttSubscribe subscribe) {
final ImmutableList subscriptions = subscribe.getSubscriptions();
subscriptionsBuilder = ImmutableList.builder(subscriptions.size() + 1);
subscriptionsBuilder.addAll(subscriptions);
}
protected abstract @NotNull B self();
public @NotNull B addSubscription(final @Nullable Mqtt5Subscription subscription) {
buildFirstSubscription();
subscriptionsBuilder.add(Checks.notImplemented(subscription, MqttSubscription.class, "Subscription"));
return self();
}
public MqttSubscriptionBuilder.@NotNull Nested addSubscription() {
return new MqttSubscriptionBuilder.Nested<>(this::addSubscription);
}
public @NotNull B addSubscriptions(final @Nullable Mqtt5Subscription @Nullable ... subscriptions) {
Checks.notNull(subscriptions, "Subscriptions");
buildFirstSubscription();
subscriptionsBuilder.ensureFree(subscriptions.length);
for (final Mqtt5Subscription subscription : subscriptions) {
addSubscription(subscription);
}
ensureAtLeastOneSubscription();
return self();
}
public @NotNull B addSubscriptions(
final @Nullable Collection<@Nullable ? extends Mqtt5Subscription> subscriptions) {
Checks.notNull(subscriptions, "Subscriptions");
buildFirstSubscription();
subscriptionsBuilder.ensureFree(subscriptions.size());
subscriptions.forEach(this::addSubscription);
ensureAtLeastOneSubscription();
return self();
}
public @NotNull B addSubscriptions(final @Nullable Stream<@Nullable ? extends Mqtt5Subscription> subscriptions) {
Checks.notNull(subscriptions, "Subscriptions");
buildFirstSubscription();
subscriptions.forEach(this::addSubscription);
ensureAtLeastOneSubscription();
return self();
}
public @NotNull B userProperties(final @Nullable Mqtt5UserProperties userProperties) {
this.userProperties = MqttChecks.userProperties(userProperties);
return self();
}
public MqttUserPropertiesImplBuilder.@NotNull Nested userProperties() {
return new MqttUserPropertiesImplBuilder.Nested<>(userProperties, this::userProperties);
}
private MqttSubscriptionBuilder.@NotNull Default getFirstSubscriptionBuilder() {
if (firstSubscriptionBuilder == null) {
firstSubscriptionBuilder = new MqttSubscriptionBuilder.Default();
}
return firstSubscriptionBuilder;
}
private void buildFirstSubscription() {
if (firstSubscriptionBuilder != null) {
subscriptionsBuilder.add(firstSubscriptionBuilder.build());
firstSubscriptionBuilder = null;
}
}
public @NotNull B topicFilter(final @Nullable String topicFilter) {
getFirstSubscriptionBuilder().topicFilter(topicFilter);
return self();
}
public @NotNull B topicFilter(final @Nullable MqttTopicFilter topicFilter) {
getFirstSubscriptionBuilder().topicFilter(topicFilter);
return self();
}
public MqttTopicFilterImplBuilder.@NotNull Nested topicFilter() {
return new MqttTopicFilterImplBuilder.Nested<>(this::topicFilter);
}
public @NotNull B qos(final @Nullable MqttQos qos) {
getFirstSubscriptionBuilder().qos(qos);
return self();
}
public @NotNull B noLocal(final boolean noLocal) {
getFirstSubscriptionBuilder().noLocal(noLocal);
return self();
}
public @NotNull B retainHandling(final @Nullable Mqtt5RetainHandling retainHandling) {
getFirstSubscriptionBuilder().retainHandling(retainHandling);
return self();
}
public @NotNull B retainAsPublished(final boolean retainAsPublished) {
getFirstSubscriptionBuilder().retainAsPublished(retainAsPublished);
return self();
}
private void ensureAtLeastOneSubscription() {
Checks.state(subscriptionsBuilder.getSize() > 0, "At least one subscription must be added.");
}
public @NotNull MqttSubscribe build() {
buildFirstSubscription();
ensureAtLeastOneSubscription();
return new MqttSubscribe(subscriptionsBuilder.build(), userProperties);
}
public static class Default extends MqttSubscribeBuilder implements Mqtt5SubscribeBuilder.Start.Complete {
public Default() {}
Default(final @NotNull MqttSubscribe subscribe) {
super(subscribe);
}
@Override
protected @NotNull Default self() {
return this;
}
}
public static class Nested extends MqttSubscribeBuilder>
implements Mqtt5SubscribeBuilder.Nested.Start.Complete {
private final @NotNull Function parentConsumer;
public Nested(final @NotNull Function parentConsumer) {
this.parentConsumer = parentConsumer;
}
@Override
protected @NotNull Nested
self() {
return this;
}
@Override
public @NotNull P applySubscribe() {
return parentConsumer.apply(build());
}
}
public static class Send
extends MqttSubscribeBuilder>
implements Mqtt5SubscribeBuilder.Send.Start.Complete {
private final @NotNull Function parentConsumer;
public Send(final @NotNull Function parentConsumer) {
this.parentConsumer = parentConsumer;
}
@Override
protected @NotNull Send
self() {
return this;
}
@Override
public @NotNull P send() {
return parentConsumer.apply(build());
}
}
public static abstract class Publishes
extends MqttSubscribeBuilder>
implements Mqtt5SubscribeBuilder.Publishes.Start.Complete, Mqtt5SubscribeBuilder.Publishes.Args
{
protected boolean manualAcknowledgement;
@Override
protected @NotNull Publishes
self() {
return this;
}
@Override
public @NotNull Publishes
manualAcknowledgement(final boolean manualAcknowledgement) {
this.manualAcknowledgement = manualAcknowledgement;
return this;
}
}
}