Top Fields Constructors Methods
com.google.common.base

pack-priv final Class PairwiseEquivalence<E, T extends @Nullable E>

extends Equivalence<Iterable<T extends @Nullable E>>
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@GwtCompatible
serializable:true
@ElementTypesAreNonnullByDefault
Imports
com.google.common.annotations.GwtCompatible, java.io.Serializable, java.util.Iterator, javax.annotation.CheckForNull, org.checkerframework.checker.nullness.qual.Nullable

Field Summary

Modifier and TypeField and Description
pack-priv final Equivalence<E>
elementEquivalence

private static final long
serialVersionUID

Constructor Summary

AccessConstructor and Description
pack-priv
PairwiseEquivalence(Equivalence<E> elementEquivalence)

Method Summary

Modifier and TypeMethod and Description
protected boolean
doEquivalent(Iterable<T> iterableA, Iterable<T> iterableB)

Implements abstract com.google.common.base.Equivalence.doEquivalent.

Implemented by the user to determine whether a and b are considered equivalent, subject to the requirements specified in equivalent.
protected int
doHash(Iterable<T> iterable)

Implements abstract com.google.common.base.Equivalence.doHash.

Implemented by the user to return a hash code for t, subject to the requirements specified in hash.
public boolean
equals(Object
the reference object with which to compare.
object)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from com.google.common.base.Equivalence:
equalsequivalentequivalentTohashidentityonResultOfpairwisetestwrap

Field Detail

elementEquivalenceback to summary
pack-priv final Equivalence<E> elementEquivalence
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

PairwiseEquivalenceback to summary
pack-priv PairwiseEquivalence(Equivalence<E> elementEquivalence)

Method Detail

doEquivalentback to summary
protected boolean doEquivalent(Iterable<T> iterableA, Iterable<T> iterableB)

Implements abstract com.google.common.base.Equivalence.doEquivalent.

Doc from com.google.common.base.Equivalence.doEquivalent.

Implemented by the user to determine whether a and b are considered equivalent, subject to the requirements specified in equivalent.

This method should not be called except by equivalent. When equivalent calls this method, a and b are guaranteed to be distinct, non-null instances.

Annotations
@Override
doHashback to summary
protected int doHash(Iterable<T> iterable)

Implements abstract com.google.common.base.Equivalence.doHash.

Doc from com.google.common.base.Equivalence.doHash.

Implemented by the user to return a hash code for t, subject to the requirements specified in hash.

This method should not be called except by hash. When hash calls this method, t is guaranteed to be non-null.

Annotations
@Override
equalsback to summary
public boolean equals(Object object)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
object:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override