org.opendaylight.persistence.util.test.easymock

Class ArgumentMatcher<T>

java.lang.Object

org.opendaylight.persistence.util.test.easymock.ArgumentMatcher<T>

Type Parameters:

T - type of the expected argument

All Implemented Interfaces:

org.easymock.IArgumentMatcher

@NotThreadSafe
public abstract class ArgumentMatcher<T>
extends Object
implements org.easymock.IArgumentMatcher

Argument matcher.

This argument matcher already verifies null-ability and type: If the argument is null or of the wrong type the match fails. null is not a valid value, if null is expected use EasyMock.isNull(Class).

Author:

Fabiel Zuniga, Nachiket Abhyankar

Constructor Summary

Constructors

Constructor and Description
ArgumentMatcher(String name) Creates an argument matcher.

Method Summary

Methods

Modifier and Type	Method and Description
void	appendTo(StringBuffer buffer)
T	match() Registers this argument matcher to EasyMock.
static <T> T	match(org.easymock.IArgumentMatcher matcher) Registers an IArgumentMatcher to EasyMock.
boolean	matches(Object arg)
protected boolean	verify(Matchable<?>... properties) Verifies whether the properties match the expected values.
abstract boolean	verifyMatch(T argument) Verifies the argument matches.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArgumentMatcher

public ArgumentMatcher(@Nonnull
               String name)

Creates an argument matcher.

Parameters:

name - name to display when the argument does not match

Method Detail

appendTo

public void appendTo(StringBuffer buffer)

Specified by:

appendTo in interface org.easymock.IArgumentMatcher

matches

public boolean matches(Object arg)

Specified by:

matches in interface org.easymock.IArgumentMatcher

verifyMatch

public abstract boolean verifyMatch(@Nonnull
                  T argument)

Verifies the argument matches.

It is recommended to use verify(Matchable...) in the implementation of this method since it adds more description to the error in case the argument doesn't match.

Parameters:

argument - argument

Returns:

true if argument matches expectations, false otherwise

verify

@SafeVarargs
protected final boolean verify(@Nonnull
                         Matchable<?>... properties)

Verifies whether the properties match the expected values.

Parameters:

properties - properties to verify

Returns:

true if the property's value matches the expected, false otherwise

match

public T match()

Registers this argument matcher to EasyMock.

Example:

 ArgumentMatcher<MyArgumentType> customArgumentMatcher = new ArgumentMatcher<MyArgumentType>() {
     ...
 };
 
 // For methods returning a value
 EasyMock.expect(mock.someMethod(myArgumentMatcher.match())).andReturn(...);
 
 // For void return methods
 mock.someMethod(myArgumentMatcher.match());
 

Returns:

irrelevant value

match

public static <T> T match(@Nonnull
          org.easymock.IArgumentMatcher matcher)

Registers an IArgumentMatcher to EasyMock.

The preferred way (type-safe) is to extend ArgumentMatcher instead of directly implementing IArgumentMatcher, and then use match().

Example:

 IArgumentMatcher customArgumentMatcher = new IArgumentMatcher() {
     ...
 };
 
 // For methods returning a value
 EasyMock.expect(mock.someMethod(ArgumentMatcher.match(customArgumentMatcher))).andReturn(...);
 
 // For void return methods
 mock.someMethod(ArgumentMatcher.match(customArgumentMatcher));
 

Type Parameters:

T - type of the argument

Parameters:

matcher - matcher to register

Returns:

irrelevant value