View Javadoc
1   /*
2    * Copyright 2014 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  
17  package io.netty.handler.codec.mqtt;
18  
19  import io.netty.util.internal.StringUtil;
20  
21  /**
22   * Contains a topic name and Qos Level.
23   * This is part of the {@link MqttSubscribePayload}
24   */
25  public final class MqttTopicSubscription {
26  
27      private final String topicFilter;
28      private final MqttSubscriptionOption option;
29  
30      public MqttTopicSubscription(String topicFilter, MqttQoS qualityOfService) {
31          this.topicFilter = topicFilter;
32          this.option = MqttSubscriptionOption.onlyFromQos(qualityOfService);
33      }
34  
35      public MqttTopicSubscription(String topicFilter, MqttSubscriptionOption option) {
36          this.topicFilter = topicFilter;
37          this.option = option;
38      }
39  
40      public String topicName() {
41          return topicFilter;
42      }
43  
44      public MqttQoS qualityOfService() {
45          return option.qos();
46      }
47  
48      public MqttSubscriptionOption option() {
49          return option;
50      }
51  
52      @Override
53      public String toString() {
54          return new StringBuilder(StringUtil.simpleClassName(this))
55              .append('[')
56              .append("topicFilter=").append(topicFilter)
57              .append(", option=").append(this.option)
58              .append(']')
59              .toString();
60      }
61  }