diff --git a/java/org/rocksdb/BloomFilter.java b/java/org/rocksdb/BloomFilter.java index 21915ed66..6772d2f54 100644 --- a/java/org/rocksdb/BloomFilter.java +++ b/java/org/rocksdb/BloomFilter.java @@ -6,7 +6,17 @@ package org.rocksdb; /** - * BloomFilter + * Bloom filter policy that uses a bloom filter with approximately + * the specified number of bits per key. + * + *
+ * Note: if you are using a custom comparator that ignores some parts + * of the keys being compared, you must not use this {@code BloomFilter} + * and must provide your own FilterPolicy that also ignores the + * corresponding parts of the keys. For example, if the comparator + * ignores trailing spaces, it would be incorrect to use a + * FilterPolicy (like {@code BloomFilter}) that does not ignore + * trailing spaces in keys.
*/ public class BloomFilter extends Filter { @@ -16,57 +26,26 @@ public class BloomFilter extends Filter { private final boolean useBlockBasedMode_; /** - * Bloom filter policy that uses a bloom filter with approximately - * the specified number of bits per key. + * BloomFilter constructor * *- * bits_per_key: bits per key in bloom filter. A good value for bits_per_key - * is 10, which yields a filter with ~ 1% false positive rate. - *
default bits_per_key: 10
- * - *use_block_based_builder: use block based filter rather than full filter. - * If you want to builder full filter, it needs to be set to false. - *
- *default mode: block based filter
- ** Callers must delete the result after any database that is using the * result has been closed.
- *- * Note: if you are using a custom comparator that ignores some parts - * of the keys being compared, you must not use this {@code BloomFilter} - * and must provide your own FilterPolicy that also ignores the - * corresponding parts of the keys. For example, if the comparator - * ignores trailing spaces, it would be incorrect to use a - * FilterPolicy (like {@code BloomFilter}) that does not ignore - * trailing spaces in keys.
*/ public BloomFilter() { this(DEFAULT_BITS_PER_KEY, DEFAULT_MODE); } /** - * Bloom filter policy that uses a bloom filter with approximately - * the specified number of bits per key. + * BloomFilter constructor * ** bits_per_key: bits per key in bloom filter. A good value for bits_per_key * is 10, which yields a filter with ~ 1% false positive rate. *
- *use_block_based_builder: use block based filter rather than full filter. - * If you want to builder full filter, it needs to be set to false. - *
- *default mode: block based filter
** Callers must delete the result after any database that is using the * result has been closed.
- *- * Note: if you are using a custom comparator that ignores some parts - * of the keys being compared, you must not use this {@code BloomFilter} - * and must provide your own FilterPolicy that also ignores the - * corresponding parts of the keys. For example, if the comparator - * ignores trailing spaces, it would be incorrect to use a - * FilterPolicy (like {@code BloomFilter}) that does not ignore - * trailing spaces in keys.
* * @param bitsPerKey number of bits to use */ @@ -75,8 +54,7 @@ public class BloomFilter extends Filter { } /** - * Bloom filter policy that uses a bloom filter with approximately - * the specified number of bits per key. + * BloomFilter constructor * ** bits_per_key: bits per key in bloom filter. A good value for bits_per_key @@ -90,14 +68,6 @@ public class BloomFilter extends Filter { *
* Callers must delete the result after any database that is using the * result has been closed.
- *- * Note: if you are using a custom comparator that ignores some parts - * of the keys being compared, you must not use this {@code BloomFilter} - * and must provide your own FilterPolicy that also ignores the - * corresponding parts of the keys. For example, if the comparator - * ignores trailing spaces, it would be incorrect to use a - * FilterPolicy (like {@code BloomFilter}) that does not ignore - * trailing spaces in keys.
* * @param bitsPerKey number of bits to use * @param useBlockBasedMode use block based mode or full filter mode