Class Equivalence<T>

    • Method Detail

      • equivalent

        public final boolean equivalent​(@Nullable
                                        T a,
                                        T b)
        Returns true if the given objects are considered equivalent.

        The equivalent method implements an equivalence relation on object references:

        • It is reflexive: for any reference x, including null, equivalent(x, x) returns true.
        • It is symmetric: for any references x and y, equivalent(x, y) == equivalent(y, x).
        • It is transitive: for any references x, y, and z, if equivalent(x, y) returns true and equivalent(y, z) returns true, then equivalent(x, z) returns true.
        • It is consistent: for any references x and y, multiple invocations of equivalent(x, y) consistently return true or consistently return false (provided that neither x nor y is modified).
      • hash

        public final int hash​(@Nullable
                              T t)
        Returns a hash code for t.

        The hash has the following properties:

        • It is consistent: for any reference x, multiple invocations of hash(x} consistently return the same value provided x remains unchanged according to the definition of the equivalence. The hash need not remain consistent from one execution of an application to another execution of the same application.
        • It is distributable accross equivalence: for any references x and y, if equivalent(x, y), then hash(x) == hash(y). It is not necessary that the hash be distributable accorss inequivalence. If equivalence(x, y) is false, hash(x) == hash(y) may still be true.
        • hash(null) is 0.
      • onResultOf

        public final <F> Equivalence<F> onResultOf​(Function<F,​? extends T> function)
        Returns a new equivalence relation for F which evaluates equivalence by first applying function to the argument, then evaluating using this. That is, for any pair of non-null objects x and y, equivalence.onResultOf(function).equivalent(a, b) is true if and only if equivalence.equivalent(function.apply(a), function.apply(b)) is true.

        For example:

            Equivalence<Person> SAME_AGE = Equivalence.equals().onResultOf(GET_PERSON_AGE);

        function will never be invoked with a null value.

        Note that function must be consistent according to this equivalence relation. That is, invoking Function.apply(F) multiple times for a given value must return equivalent results. For example, Equivalence.identity().onResultOf(Functions.toStringFunction()) is broken because it's not guaranteed that Object.toString()) always returns the same string instance.

      • wrap

        public final <S extends TEquivalence.Wrapper<S> wrap​(@Nullable
                                                               S reference)
        Returns a wrapper of reference that implements Object.equals() such that wrap(this, a).equals(wrap(this, b)) if and only if this.equivalent(a, b).
      • pairwise

        public final <S extends TEquivalence<Iterable<S>> pairwise()
        Returns an equivalence over iterables based on the equivalence of their elements. More specifically, two iterables are considered equivalent if they both contain the same number of elements, and each pair of corresponding elements is equivalent according to this. Null iterables are equivalent to one another.

        Note that this method performs a similar function for equivalences as Ordering.lexicographical() does for orderings.

      • equivalentTo

        public final Predicate<T> equivalentTo​(@Nullable
                                               T target)
        Returns a predicate that evaluates to true if and only if the input is equivalent to target according to this equivalence relation.