Top Description Fields Constructors Methods
org.easymock.internal.matchers

public Class Equals

extends Object
implements IArgumentMatcher, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.easymock.IArgumentMatcher
Known Direct Subclasses
org.easymock.internal.matchers.ArrayEquals
Imports
java.io.Serializable, org.easymock.IArgumentMatcher, org.easymock.internal.ArgumentToString

Matches if the argument is equal to the given value.
Author
OFFIS, Tammo Freese

Field Summary

Modifier and TypeField and Description
private final Object
private static final long

Constructor Summary

AccessConstructor and Description
public
Equals(Object expected)

Method Summary

Modifier and TypeMethod and Description
public void
appendTo(StringBuffer
the buffer to which the string representation is appended.
buffer
)

Implements org.easymock.IArgumentMatcher.appendTo.

Appends a string representation of this matcher to the given buffer.
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
matches(Object
the argument
actual
)

Implements org.easymock.IArgumentMatcher.matches.

Returns whether this matcher accepts the given argument.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

expectedback to summary
private final Object expected
serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Equalsback to summary
public Equals(Object expected)

Method Detail

appendToback to summary
public void appendTo(StringBuffer buffer)

Implements org.easymock.IArgumentMatcher.appendTo.

Doc from org.easymock.IArgumentMatcher.appendTo.

Appends a string representation of this matcher to the given buffer. In case of failure, the printed message will show this string to allow to know which matcher was used for the failing call.

Parameters
buffer:StringBuffer

the buffer to which the string representation is appended.

equalsback to summary
public boolean equals(Object o)

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
o: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
getExpectedback to summary
protected final Object getExpected()
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
matchesback to summary
public boolean matches(Object actual)

Implements org.easymock.IArgumentMatcher.matches.

Doc from org.easymock.IArgumentMatcher.matches.

Returns whether this matcher accepts the given argument.

Like Object.equals(), it should be aware that the argument passed might be null and of any type. So you will usually start the method with an instanceof and/or null check.

The method should never assert if the argument doesn't match. It should only return false. EasyMock will take care of asserting if the call is really unexpected.

Parameters
actual:Object

the argument

Returns:boolean

whether this matcher accepts the given argument.