made BloomFilterIndexer and HashFunctionValidator public (#139)

This commit is contained in:
Claude Warren 2020-04-21 16:27:23 +01:00 committed by GitHub
parent aab2b832f9
commit 0c39fbd170
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 7 deletions

View File

@ -19,7 +19,7 @@ package org.apache.commons.collections4.bloomfilter;
/** /**
* Contains functions to convert {@code int} indices into Bloom filter bit positions. * Contains functions to convert {@code int} indices into Bloom filter bit positions.
*/ */
final class BloomFilterIndexer { public final class BloomFilterIndexer {
/** A bit shift to apply to an integer to divided by 64 (2^6). */ /** A bit shift to apply to an integer to divided by 64 (2^6). */
private static final int DIVIDE_BY_64 = 6; private static final int DIVIDE_BY_64 = 6;
@ -32,7 +32,7 @@ final class BloomFilterIndexer {
* @param bitIndex the bit index * @param bitIndex the bit index
* @throws IndexOutOfBoundsException if the index is not positive * @throws IndexOutOfBoundsException if the index is not positive
*/ */
static void checkPositive(int bitIndex) { public static void checkPositive(int bitIndex) {
if (bitIndex < 0) { if (bitIndex < 0) {
throw new IndexOutOfBoundsException("Negative bitIndex: " + bitIndex); throw new IndexOutOfBoundsException("Negative bitIndex: " + bitIndex);
} }
@ -52,7 +52,7 @@ final class BloomFilterIndexer {
* @return the filter index * @return the filter index
* @see #checkPositive(int) * @see #checkPositive(int)
*/ */
static int getLongIndex(int bitIndex) { public static int getLongIndex(int bitIndex) {
// An integer divide by 64 is equivalent to a shift of 6 bits if the integer is positive. // An integer divide by 64 is equivalent to a shift of 6 bits if the integer is positive.
// We do not explicitly check for a negative here. Instead we use a // We do not explicitly check for a negative here. Instead we use a
// a signed shift. Any negative index will produce a negative value // a signed shift. Any negative index will produce a negative value
@ -74,7 +74,7 @@ final class BloomFilterIndexer {
* @return the filter bit * @return the filter bit
* @see #checkPositive(int) * @see #checkPositive(int)
*/ */
static long getLongBit(int bitIndex) { public static long getLongBit(int bitIndex) {
// Bit shifts only use the first 6 bits. Thus it is not necessary to mask this // Bit shifts only use the first 6 bits. Thus it is not necessary to mask this
// using 0x3f (63) or compute bitIndex % 64. // using 0x3f (63) or compute bitIndex % 64.
// Note: If the index is negative the shift will be (64 - (bitIndex & 0x3f)) and // Note: If the index is negative the shift will be (64 - (bitIndex & 0x3f)) and

View File

@ -22,7 +22,7 @@ import java.util.Objects;
/** /**
* Contains validation for hash functions. * Contains validation for hash functions.
*/ */
final class HashFunctionValidator { public final class HashFunctionValidator {
/** Do not instantiate. */ /** Do not instantiate. */
private HashFunctionValidator() {} private HashFunctionValidator() {}
@ -66,7 +66,7 @@ final class HashFunctionValidator {
* @return true, if successful * @return true, if successful
* @see String#equalsIgnoreCase(String) * @see String#equalsIgnoreCase(String)
*/ */
static boolean areEqual(HashFunctionIdentity a, HashFunctionIdentity b) { public static boolean areEqual(HashFunctionIdentity a, HashFunctionIdentity b) {
return (a.getSignedness() == b.getSignedness() && return (a.getSignedness() == b.getSignedness() &&
a.getProcessType() == b.getProcessType() && a.getProcessType() == b.getProcessType() &&
a.getName().equalsIgnoreCase(b.getName())); a.getName().equalsIgnoreCase(b.getName()));
@ -81,7 +81,7 @@ final class HashFunctionValidator {
* @see #areEqual(HashFunctionIdentity, HashFunctionIdentity) * @see #areEqual(HashFunctionIdentity, HashFunctionIdentity)
* @throws IllegalArgumentException if the hash functions are not equal * @throws IllegalArgumentException if the hash functions are not equal
*/ */
static void checkAreEqual(HashFunctionIdentity a, HashFunctionIdentity b) { public static void checkAreEqual(HashFunctionIdentity a, HashFunctionIdentity b) {
if (!areEqual(a, b)) { if (!areEqual(a, b)) {
throw new IllegalArgumentException(String.format("Hash functions are not equal: (%s) != (%s)", throw new IllegalArgumentException(String.format("Hash functions are not equal: (%s) != (%s)",
HashFunctionIdentity.asCommonString(a), HashFunctionIdentity.asCommonString(b))); HashFunctionIdentity.asCommonString(a), HashFunctionIdentity.asCommonString(b)));