com.google.common.base

Class Equivalence.Wrapper<T>

java.lang.Object

com.google.common.base.Equivalence.Wrapper<T>

All Implemented Interfaces:

Serializable

Enclosing class:

Equivalence<T>

public static final class Equivalence.Wrapper<T>
extends Object
implements Serializable

Wraps an object so that equals(Object) and hashCode() delegate to an Equivalence.

For example, given an Equivalence for strings named equiv that tests equivalence using their lengths:

 equiv.wrap("a").equals(equiv.wrap("b")) // true
 equiv.wrap("a").equals(equiv.wrap("hello")) // false
 

Note in particular that an equivalence wrapper is never equal to the object it wraps.

 equiv.wrap(obj).equals(obj) // always false
 

Since:

10.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Returns true if Equivalence.equivalent(Object, Object) applied to the wrapped references is true and both wrappers use the same equivalence.
T	get() Returns the (possibly null) reference wrapped by this instance.
int	hashCode() Returns the result of Equivalence.hash(Object) applied to the wrapped reference.
String	toString() Returns a string representation for this equivalence wrapper.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

get

@NullableDecl
public T get()

Returns the (possibly null) reference wrapped by this instance.

equals

public boolean equals(@NullableDecl
                      Object obj)

Returns true if Equivalence.equivalent(Object, Object) applied to the wrapped references is true and both wrappers use the same equivalence.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

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

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns the result of Equivalence.hash(Object) applied to the wrapped reference.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns a string representation for this equivalence wrapper. The form of this string representation is not specified.

Overrides:

toString in class Object

Returns:

a string representation of the object.