hbase-common/src/main/java/org/apache/hadoop/hbase/util/HashKey.java

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package org.apache.hadoop.hbase.util;
  19
  20 import org.apache.yetus.audience.InterfaceAudience;
  21
  22 /**
  23  * Used to calculate the hash {@link Hash} algorithms for Bloomfilters.
  24  *
  25  * @param <T> the type of HashKey
  26  */
  27 @InterfaceAudience.Private
  28 public abstract class HashKey<T> {
  29   protected final T t;
  30
  31   public HashKey(T t) {
  32     this.t = t;
  33   }
  34
  35   /**
  36    * @param pos
  37    * @return The byte at the given position in this HashKey
  38    */
  39   public abstract byte get(int pos);
  40
  41   /**
  42    * @return The number of bytes in this HashKey
  43    */
  44   public abstract int length();
  45 }