Top Description Fields Constructors Methods
org.hamcrest.core

public Class IsEqual<T>

extends BaseMatcher<T>
Class Inheritance
Imports
org.hamcrest.BaseMatcher, .Description, .Factory, .Matcher, java.lang.reflect.Array
Is the value equal to another value, as tested by the java.lang.Object#equals invokedMethod?

Field Summary

Modifier and TypeField and Description
private final Object
expectedValue

Constructor Summary

AccessConstructor and Description
public
IsEqual(T equalArg)

Method Summary

Modifier and TypeMethod and Description
private static boolean
areArrayElementsEqual(Object actualArray, Object expectedArray)

private static boolean
areArrayLengthsEqual(Object actualArray, Object expectedArray)

private static boolean
areArraysEqual(Object actualArray, Object expectedArray)

private static boolean
areEqual(Object actual, Object expected)

public void
describeTo(Description
The description to be built or appended to.
description)

Implements org.hamcrest.SelfDescribing.describeTo.

Generates a description of the object.
public static <T> Matcher<T>
equalTo(T operand)

Creates a matcher that matches when the examined object is logically equal to the specified operand, as determined by calling the java.lang.Object#equals method on the examined object.

private static boolean
isArray(Object o)

public boolean
matches(Object
the object against which the matcher is evaluated.
actualValue)

Implements org.hamcrest.Matcher.matches.

Evaluates the matcher for argument item.
Inherited from org.hamcrest.BaseMatcher:
_dont_implement_Matcher___instead_extend_BaseMatcher_describeMismatchtoString

Field Detail

expectedValueback to summary
private final Object expectedValue

Constructor Detail

IsEqualback to summary
public IsEqual(T equalArg)

Method Detail

areArrayElementsEqualback to summary
private static boolean areArrayElementsEqual(Object actualArray, Object expectedArray)
areArrayLengthsEqualback to summary
private static boolean areArrayLengthsEqual(Object actualArray, Object expectedArray)
areArraysEqualback to summary
private static boolean areArraysEqual(Object actualArray, Object expectedArray)
areEqualback to summary
private static boolean areEqual(Object actual, Object expected)
describeToback to summary
public void describeTo(Description description)

Implements org.hamcrest.SelfDescribing.describeTo.

Doc from org.hamcrest.SelfDescribing.describeTo.

Generates a description of the object. The description may be part of a a description of a larger object of which this is just a component, so it should be worded appropriately.

Parameters
description:Description

The description to be built or appended to.

Annotations
@Override
equalToback to summary
public static <T> Matcher<T> equalTo(T operand)

Creates a matcher that matches when the examined object is logically equal to the specified operand, as determined by calling the java.lang.Object#equals method on the examined object.

If the specified operand is null then the created matcher will only match if the examined object's equals method returns true when passed a null (which would be a violation of the equals contract), unless the examined object itself is null, in which case the matcher will return a positive match.

The created matcher provides a special behaviour when examining Arrays, whereby it will match if both the operand and the examined object are arrays of the same length and contain items that are equal to each other (according to the above rules) in the same indexes.

For example: 

assertThat("foo", equalTo("foo"));
assertThat(new String[] {"foo", "bar"}, equalTo(new String[] {"foo", "bar"}));
Annotations
@Factory
isArrayback to summary
private static boolean isArray(Object o)
matchesback to summary
public boolean matches(Object actualValue)

Implements org.hamcrest.Matcher.matches.

Doc from org.hamcrest.Matcher.matches.

Evaluates the matcher for argument item.

This method matches against Object, instead of the generic type T. This is because the caller of the Matcher does not know at runtime what the type is (because of type erasure with Java generics). It is down to the implementations to check the correct type.

Parameters
actualValue:Object

the object against which the matcher is evaluated.

Returns:boolean

true if item matches, otherwise false.

Annotations
@Override