hbase-common/src/main/java/org/apache/hadoop/hbase/util/ImmutableByteArray.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.hbase.util;

import org.apache.hadoop.hbase.classification.InterfaceAudience;

/**
 * Mainly used as keys for HashMap.
 */
@InterfaceAudience.Private
public final class ImmutableByteArray {

  private final byte[] b;

  private ImmutableByteArray(byte[] b) {
    this.b = b;
  }

  @Override
  public int hashCode() {
    return Bytes.hashCode(b);
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == null || obj.getClass() != ImmutableByteArray.class) {
      return false;
    }
    return Bytes.equals(b, ((ImmutableByteArray) obj).b);
  }

  public static ImmutableByteArray wrap(byte[] b) {
    return new ImmutableByteArray(b);
  }

  public String toStringUtf8() {
    return Bytes.toString(b);
  }
}