View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.util;
20  
21  import org.apache.hadoop.hbase.classification.InterfaceAudience;
22  
23  /**
24   * Common methods Bloom filter methods required at read and write time.
25   */
26  @InterfaceAudience.Private
27  public interface BloomFilterBase {
28  
29    /**
30     * @return The number of keys added to the bloom
31     */
32    long getKeyCount();
33  
34    /**
35     * @return The max number of keys that can be inserted
36     *         to maintain the desired error rate
37     */
38    long getMaxKeys();
39  
40    /**
41     * @return Size of the bloom, in bytes
42     */
43    long getByteSize();
44  }