net.mintern.primitive.comparators

Interface BooleanComparator

public interface BooleanComparator

A comparison function that imposes total ordering on boolean values.

This is a @FunctionalInterface even though it isn't declared as one, so that it can be used in Java 6+.

Method Summary

Modifier and Type	Method and Description
int	compare(boolean b1, boolean b2) Compares b1 and b2.

Method Detail

compare

int compare(boolean b1,
            boolean b2)

Compares b1 and b2. Returns a negative value to indicate that b1 < b2, 0 to indicate that b1 == b2, and a positive value to indicate that b1 > b2.

Implementations of this method must maintain the following invariants:

• s(compare(x, y)) == -s(compare(y, x))
• s(compare(x, y)) == s(compare(y, z)) → s(compare(x, y)) == s(compare(x, z)) (transitivity)
• compare(x, y) == 0 → s(compare(x, z)) == s(compare(y, z)) ∀ z

where s(x) is defined as follows:

• x < 0: -1
• x == 0: 0
• x > 0: 1

Parameters:

b1 - the first boolean to compare

b2 - the second boolean to compare

Returns:

a negative value, 0, or a positive value to indicate that b1 is less than, equal to, or greater than b2, respectively