hadoop-hdfs-project/hadoop-hdfs/src/main/java/org/apache/hadoop/hdfs/protocol/EncryptionZoneWithId.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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
 *
 *     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 org.apache.hadoop.hdfs.protocol;

import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.hadoop.classification.InterfaceAudience;

/**
 * Internal class similar to an {@link EncryptionZone} which also holds a
 * unique id. Used to implement batched listing of encryption zones.
 */
@InterfaceAudience.Private
public class EncryptionZoneWithId extends EncryptionZone {

  final long id;

  public EncryptionZoneWithId(String path, String keyName, long id) {
    super(path, keyName);
    this.id = id;
  }

  public long getId() {
    return id;
  }

  EncryptionZone toEncryptionZone() {
    return new EncryptionZone(getPath(), getKeyName());
  }

  @Override
  public int hashCode() {
    return new HashCodeBuilder(17, 29)
        .append(super.hashCode())
        .append(id)
        .toHashCode();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    if (!super.equals(o)) {
      return false;
    }

    EncryptionZoneWithId that = (EncryptionZoneWithId) o;

    if (id != that.id) {
      return false;
    }

    return true;
  }

  @Override
  public String toString() {
    return "EncryptionZoneWithId [" +
        "id=" + id +
        ", " + super.toString() +
        ']';
  }
}