/*
    * Copyright 2014 The Netty Project
    *
    * The Netty Project licenses this file to you 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:
    *
    *   https://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 io.netty.handler.codec.mqtt;
  
  import io.netty.util.internal.StringUtil;
  
  /**
   * Variable Header of the {@link MqttPublishMessage}
   */
  public final class MqttPublishVariableHeader {
  
      private final String topicName;
      private final int packetId;
      private final MqttProperties properties;
  
      public MqttPublishVariableHeader(String topicName, int packetId) {
          this(topicName, packetId, MqttProperties.NO_PROPERTIES);
      }
  
      public MqttPublishVariableHeader(String topicName, int packetId, MqttProperties properties) {
          this.topicName = topicName;
          this.packetId = packetId;
          this.properties = MqttProperties.withEmptyDefaults(properties);
      }
  
      public String topicName() {
          return topicName;
      }
  
      /**
       * @deprecated Use {@link #packetId()} instead.
       */
      @Deprecated
      public int messageId() {
          return packetId;
      }
  
      public int packetId() {
          return packetId;
      }
  
      public MqttProperties properties() {
          return properties;
      }
  
      @Override
      public String toString() {
          return new StringBuilder(StringUtil.simpleClassName(this))
              .append('[')
              .append("topicName=").append(topicName)
              .append(", packetId=").append(packetId)
              .append(']')
              .toString();
      }
  }