001/*
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase.util;
020
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Common methods Bloom filter methods required at read and write time.
025 */
026@InterfaceAudience.Private
027public interface BloomFilterBase {
028
029  /**
030   * @return The number of keys added to the bloom
031   */
032  long getKeyCount();
033
034  /**
035   * @return The max number of keys that can be inserted
036   *         to maintain the desired error rate
037   */
038  long getMaxKeys();
039
040  /**
041   * @return Size of the bloom, in bytes
042   */
043  long getByteSize();
044}