mockit

Class Expectations

java.lang.Object

mockit.Expectations

Direct Known Subclasses:

StrictExpectations

public abstract class Expectations
extends Object

Used to record expectations on mocked types and their instances.

Each recorded expectation is intended to match one or more method or constructor invocations, that we expect will occur during the execution of code under test. When a match is detected, the recorded result is returned to the caller. Alternatively, a recorded exception/error is thrown, or an arbitrary delegate method is executed.

Expectations are recorded simply by invoking the desired method or constructor on the mocked type/instance, during the initialization of an Expectations object. Typically, this is done by instantiating an anonymous subclass containing an instance initialization body, or as we call it, an expectation block:

 // Record one or more expectations on available mocked types/instances.
 new Expectations() {{
    mock1.expectedMethod(anyInt); result = 123; times = 2;
    mock2.anotherExpectedMethod(1, "test"); result = new String[] {"Abc", "xyz"};
 }};

 // Exercise tested code, with previously recorded expectations now available for replay.
 codeUnderTest.doSomething();
 

Rather than creating anonymous subclasses, we can also create named subclasses to be reused in multiple tests. Some examples:

 public final class MyReusableExpectations extends Expectations {
    public MyReusableExpectations(...any parameters...) {
       // expectations recorded here
    }
 }

 public class ReusableBaseExpectations extends Expectations {
     protected ReusableBaseExpectations(...) {
        // expectations here
     }
 }

 @Test
 public void someTest(@Mocked final SomeType aMock, etc.) {
     // Record reusable expectations by instantiating a final "...Expectations" class.
     new MyReusableExpectations(123, "test", etc.);

     // Record and extend reusable expectations by instantiating a non-final base class.
     new ReusableBaseExpectations() {{
        // additional expectations
     }};
 }
 

During replay, invocations matching a recorded expectation must occur at least once (unless specified otherwise); if, by the end of the test, no matching invocation occurred for a given recorded expectation, the test will fail with a MissingInvocation error.

When multiple expectations are recorded, matching invocations are allowed to occur in a different order. So, the order in which expectations are recorded is not significant.

Besides the special result field already mentioned, there are several other fields and methods which can be used inside the expectation block: a) returns(Object, Object...), a convenience method for returning a sequence of values; b) argument matchers such as anyInt, anyString, withNotNull(), etc., which relax or constrain the matching of argument values; c) the times, minTimes, and maxTimes fields, which relax or constrain the expected and/or allowed number of matching invocations.

By default, the exact instance on which instance method invocations will occur during replay is not verified to be the same as the instance used when recording the expectation. That said, instance-specific matching can be obtained by declaring the mocked type as @Injectable, by using the onInstance(Object) method, or by declaring multiple mock fields and/or mock parameters of the same mocked type (so that separate expectations can be recorded for each mock instance).

Invocations occurring during replay, whether they matched recorded expectations or not, can be explicitly verified after exercising the code under test. To that end, we use a set of complementary base classes: Verifications, VerificationsInOrder, FullVerifications, and FullVerificationsInOrder. Similar to expectation blocks, these classes allow us to create verification blocks.

Finally, note that this class has a specialized subclass: StrictExpectations. That one differs in that 1) each recorded expectation has, by default, a maximum allowed number of invocations of 1 (one); 2) matching invocations must occur in the same order as recorded; 3) only matching invocations are allowed, with any occurrence of unmatched invocations causing the test to fail with an UnexpectedInvocation error; and 4) use of verification blocks is not supported, since all invocations are implicitly verified through the strictly recorded sequence of expectations. Most tests can and should only use Expectations; StrictExpectations are meant for users who prefer a mocking style where all expectations are specified before exercising the code under test, or for situations where the recording of a strict sequence of expectations produces a test that is more succinct or that fails as early as an unexpected invocation occurs.

See Also:

Expectations(), Expectations(Object...), Expectations(Integer, Object...), Tutorial

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	any Matches any Object reference received by a parameter of a reference type.
protected Boolean	anyBoolean Matches any boolean or Boolean value received by a parameter of that type.
protected Byte	anyByte Matches any byte or Byte value received by a parameter of that type.
protected Character	anyChar Matches any char or Character value received by a parameter of that type.
protected Double	anyDouble Matches any double or Double value received by a parameter of that type.
protected Float	anyFloat Matches any float or Float value received by a parameter of that type.
protected Integer	anyInt Matches any int or Integer value received by a parameter of that type.
protected Long	anyLong Matches any long or Long value received by a parameter of that type.
protected Short	anyShort Matches any short or Short value received by a parameter of that type.
protected String	anyString Matches any String value received by a parameter of this type.
protected int	maxTimes A non-negative value assigned to this field will be taken as the maximum number of times that invocations matching the current expectation should occur during replay.
protected int	minTimes A non-negative value assigned to this field will be taken as the minimum number of times that invocations matching the current expectation should occur during replay.
protected Object	result A value assigned to this field will be taken as the result for the expectation that is being recorded.
protected int	times A non-negative value assigned to this field will be taken as the exact number of times that invocations matching the current expectation should occur during replay.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Expectations() Registers one or more expectations recorded on available mocked types and/or mocked instances, as written inside the instance initialization body of an anonymous subclass or the called constructor of a named subclass.
protected	Expectations(Integer numberOfIterations, Object... classesOrObjectsToBePartiallyMocked) Same as Expectations(Object...), but considering that the invocations inside the block will occur in a given number of iterations.
protected	Expectations(Object... classesOrObjectsToBePartiallyMocked) Same as Expectations(), except that one or more classes will be partially mocked according to the expectations recorded in the expectation block.

Method Summary

Modifier and Type	Method and Description
protected <T> T	onInstance(T mockedInstance) Calling this method causes the expectation recorded/verified on the given mocked instance to match only those invocations that occur on the same instance, at replay time.
protected void	returns(Object firstValue, Object... remainingValues) Specifies that the previously recorded method invocation will return a given sequence of values during replay.
protected <T> T	with(Delegate<? super T> objectWithDelegateMethod) Applies a custom argument matcher for a parameter in the current expectation.
protected <T> T	withAny(T arg) Same as withEqual(Object), but matching any argument value of the appropriate type.
protected <T> T	withArgThat(org.hamcrest.Matcher<? super T> argumentMatcher) Applies a Hamcrest argument matcher for a parameter in the current expectation.
protected <T> T	withCapture(List<T> valueHolderForMultipleInvocations) Captures the argument value passed into the associated expectation parameter, for each invocation that matches the expectation when the tested code is exercised.
protected double	withEqual(double value, double delta) Same as withEqual(Object), but checking that a numeric invocation argument in the replay phase is sufficiently close to the given value.
protected float	withEqual(float value, double delta) Same as withEqual(Object), but checking that a numeric invocation argument in the replay phase is sufficiently close to the given value.
protected <T> T	withEqual(T arg) When passed as argument for an expectation, creates a new matcher that will check if the given value is equal to the corresponding argument received by a matching invocation.
protected <T> T	withInstanceLike(T object) Same as withEqual(Object), but checking that an invocation argument in the replay phase is an instance of the same class as the given object.
protected <T> T	withInstanceOf(Class<T> argClass) Same as withEqual(Object), but checking that an invocation argument in the replay phase is an instance of the given class.
protected <T extends CharSequence> T	withMatch(T regex) Same as withEqual(Object), but checking that a textual invocation argument in the replay phase matches the given regular expression.
protected <T> T	withNotEqual(T arg) Same as withEqual(Object), but checking that the invocation argument in the replay phase is different from the given value.
protected <T> T	withNotNull() Same as withEqual(Object), but checking that an invocation argument in the replay phase is not null.
protected <T> T	withNull() Same as withEqual(Object), but checking that an invocation argument in the replay phase is null.
protected <T extends CharSequence> T	withPrefix(T text) Same as withEqual(Object), but checking that a textual invocation argument in the replay phase starts with the given text.
protected <T> T	withSameInstance(T object) Same as withEqual(Object), but checking that an invocation argument in the replay phase is the exact same instance as the one in the recorded/verified invocation.
protected <T extends CharSequence> T	withSubstring(T text) Same as withEqual(Object), but checking that a textual invocation argument in the replay phase contains the given text as a substring.
protected <T extends CharSequence> T	withSuffix(T text) Same as withEqual(Object), but checking that a textual invocation argument in the replay phase ends with the given text.

Methods inherited from class java.lang.Object

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

Field Detail

result

protected Object result

A value assigned to this field will be taken as the result for the expectation that is being recorded.

If the value is a Throwable then it will be thrown when a matching invocation later occurs. Otherwise, it's assumed to be a return value for a non-void method, and will be returned from a matching invocation.

If no result is recorded for a given expectation, then all matching invocations will return the appropriate default value according to the method return type:

• Most java.lang types (String, Object, etc.): returns null.
• java.math types (BigDecimal, etc.): returns null.
• Primitive/wrapper types: returns the standard default value (false for boolean/Boolean, 0 for int/Integer, and so on).
• java.util.List, java.util.Collection, or java.lang.Iterable: returns Collections.EMPTY_LIST.
• java.util.Iterator or java.util.ListIterator: returns an empty iterator.
• java.util.Set: returns Collections.EMPTY_SET.
• java.util.SortedSet: returns an unmodifiable empty sorted set.
• java.util.Map: returns Collections.EMPTY_MAP.
• java.util.SortedMap: returns an unmodifiable empty sorted map.
• java.util.Optional: returns Optional.empty().
• Other reference types: returns a mocked instance through cascading.
• Array types: returns an array with zero elements (empty) in each dimension.

When an expectation is recorded for a method which actually returns an exception or error (as opposed to throwing one), then the returns(Object, Object...) method should be used instead, as it only applies to return values.

Assigning a value whose type differs from the method return type will cause an IllegalArgumentException to be thrown, unless it can be safely converted to the return type. One such conversion is from an array to a collection or iterator. Another is from an array of at least two dimensions to a map, with the first dimension providing the keys and the second the values. Yet another conversion is from a single value to a container type holding that value.

A sequence of consecutive results can be recorded simply by assigning the field multiple times for the same expectation. Alternatively, the desired sequence of results for a single-valued return type can be recorded by assigning an array, an Iterable, or an Iterator containing the individual results in order.

Results that depend on some programming logic can be provided through a Delegate object assigned to the field. This applies to void and non-void methods, as well as to constructors.

Finally, when recording an expectation on a constructor of a mocked class, an arbitrary instance of said class can be assigned to the field. In this case, the assigned instance will be used as a "replacement" for all invocations to instance methods made on other instances, provided they get created sometime later through a matching constructor invocation.

See Also:

returns(Object, Object...), Tutorial

any

protected final Object any

Matches any Object reference received by a parameter of a reference type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Notice the use of this field will usually require a cast to the specific parameter type. However, if there is any other parameter for which an argument matching constraint is specified, passing the null reference instead will have the same effect.

To match an entire varargs parameter of element type V (ie, all arguments in the array), cast it to the parameter type: "(V[]) any".

See Also:

anyBoolean, anyByte, anyChar, anyDouble, anyFloat, anyInt, anyLong, anyShort, anyString, Tutorial

anyBoolean

protected final Boolean anyBoolean

Matches any boolean or Boolean value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyByte, anyChar, anyDouble, anyFloat, anyInt, anyLong, anyShort, anyString, any, Tutorial

anyByte

protected final Byte anyByte

Matches any byte or Byte value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyChar, anyDouble, anyFloat, anyInt, anyLong, anyShort, anyString, any, Tutorial

anyChar

protected final Character anyChar

Matches any char or Character value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyByte, anyDouble, anyFloat, anyInt, anyLong, anyShort, anyString, any, Tutorial

anyDouble

protected final Double anyDouble

Matches any double or Double value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyByte, anyChar, anyFloat, anyInt, anyLong, anyShort, anyString, any, Tutorial

anyFloat

protected final Float anyFloat

Matches any float or Float value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyByte, anyChar, anyDouble, anyInt, anyLong, anyString, anyShort, any, Tutorial

anyInt

protected final Integer anyInt

Matches any int or Integer value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyByte, anyChar, anyDouble, anyFloat, anyLong, anyShort, anyString, any, Tutorial

anyLong

protected final Long anyLong

Matches any long or Long value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyByte, anyChar, anyDouble, anyFloat, anyInt, anyShort, anyString, any, Tutorial

anyShort

protected final Short anyShort

Matches any short or Short value received by a parameter of that type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyByte, anyChar, anyDouble, anyFloat, anyInt, anyLong, anyString, any, Tutorial

anyString

protected final String anyString

Matches any String value received by a parameter of this type.

This field can only be used as the argument value at the proper parameter position in a method/constructor invocation, when recording or verifying an expectation; it cannot be used anywhere else.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

See Also:

anyBoolean, anyByte, anyChar, anyDouble, anyFloat, anyInt, anyLong, anyShort, any, Tutorial

maxTimes

protected int maxTimes

A non-negative value assigned to this field will be taken as the maximum number of times that invocations matching the current expectation should occur during replay. A negative value implies there is no upper limit.

Both minTimes and maxTimes can be specified for the same expectation, as long as minTimes is assigned first.

See Also:

times, minTimes, Tutorial

minTimes

protected int minTimes

A non-negative value assigned to this field will be taken as the minimum number of times that invocations matching the current expectation should occur during replay. Zero or a negative value implies there is no lower limit. The maximum number of times is automatically adjusted to allow any number of invocations.

Both minTimes and maxTimes can be specified for the same expectation, as long as minTimes is assigned first.

See Also:

times, maxTimes, Tutorial

times

protected int times

A non-negative value assigned to this field will be taken as the exact number of times that invocations matching the current expectation should occur during replay.

See Also:

minTimes, maxTimes, Tutorial

Constructor Detail

Expectations

protected Expectations()

Registers one or more expectations recorded on available mocked types and/or mocked instances, as written inside the instance initialization body of an anonymous subclass or the called constructor of a named subclass.

See Also:

Expectations(Object...), Expectations(Integer, Object...)

Expectations

protected Expectations(Integer numberOfIterations,
                       Object... classesOrObjectsToBePartiallyMocked)

Same as Expectations(Object...), but considering that the invocations inside the block will occur in a given number of iterations.

The effect of specifying a number of iterations larger than 1 (one) is equivalent to multiplying by that number the lower and upper invocation count limits for each invocation inside the expectation block.

It's also valid to have multiple expectation blocks for the same test, each with an arbitrary number of iterations.

Parameters:

numberOfIterations - the positive number of iterations for the whole set of expectations recorded inside the block; when not specified, 1 (one) iteration is assumed

classesOrObjectsToBePartiallyMocked - one or more classes or objects whose classes are to be partially mocked

See Also:

Expectations(), Tutorial

Expectations

protected Expectations(Object... classesOrObjectsToBePartiallyMocked)

Same as Expectations(), except that one or more classes will be partially mocked according to the expectations recorded in the expectation block.

The classes to be partially mocked are those directly specified through their Class objects as well as those to which any given objects belong. During replay, any invocations to one of these classes or objects will execute real production code, unless a matching expectation was recorded. This mechanism, however, does not apply to native methods, which are not supported for partial mocking.

For a given Class object, all constructors and methods can be mocked, from the specified class up to but not including java.lang.Object. For a given object, only methods can be mocked, not constructors; also, during replay, invocations to instance methods will only match expectations recorded on the given instance (or instances, if more than one was given).

Parameters:

classesOrObjectsToBePartiallyMocked - one or more classes or objects whose classes are to be partially mocked

Throws:

IllegalArgumentException - if given a class literal for an interface, an annotation, an array, a primitive/wrapper type, or a proxy class created for an interface, or if given a value/instance of such a type

See Also:

Expectations(Integer, Object...), Tutorial

Method Detail

returns

protected final void returns(Object firstValue,
                             Object... remainingValues)

Specifies that the previously recorded method invocation will return a given sequence of values during replay.

Calling this method is equivalent to assigning the result field two or more times in sequence, or assigning it a single time with an array or iterable containing the same sequence of values.

Certain data conversions will be applied, depending on the return type of the recorded method:

1. If the return type is iterable and can receive a List value, then the given sequence of values will be converted into an ArrayList; this list will then be returned by matching invocations at replay time.
2. If the return type is SortedSet or a sub-type, then the given sequence of values will be converted into a TreeSet; otherwise, if it is Set or a sub-type, then a LinkedHashSet will be created to hold the values; the set will then be returned by matching invocations at replay time.
3. If the return type is Iterator or a sub-type, then the given sequence of values will be converted into a List and the iterator created from this list will be returned by matching invocations at replay time.
4. If the return type is an array, then the given sequence of values will be converted to an array of the same type, which will be returned by matching invocations at replay time.

The current expectation will have its upper invocation count automatically set to the total number of values specified to be returned. This upper limit can be overridden through the maxTimes field, if necessary.

If this method is used for a constructor or void method, the given return values will be ignored, but matching invocations will be allowed during replay; they will simply do nothing.

Parameters:

firstValue - the first value to be returned at replay time

remainingValues - the remaining values to be returned, in the same order

See Also:

Tutorial

onInstance

protected final <T> T onInstance(T mockedInstance)

Calling this method causes the expectation recorded/verified on the given mocked instance to match only those invocations that occur on the same instance, at replay time.

By default, such instances can be different between the replay phase and the record or verify phase, even though the method or constructor invoked is the same, and the invocation arguments all match. The use of this method allows invocations to also be matched on the instance invoked.

Typically, tests that need to match instance invocations on the mocked instances invoked will declare two or more mock fields and/or mock parameters of the exact same mocked type. These instances will then be passed to the code under test, which will invoke them during the replay phase. To avoid the need to explicitly call onInstance(Object) on each of these different instances of the same type, instance matching is implied (and automatically applied to all relevant invocations) whenever two or more mocked instances of the same type are in scope for a given test method. This property of the API makes the use of onInstance much less frequent than it might otherwise be.

In most cases, an invocation to the given mocked instance will be made on the value returned by this method (ie, a chained invocation). However, in the situation where the tested method calls an instance method defined in a mocked super-class (possibly an overridden method called through the super keyword), it will be necessary to match on a different instance than the one used for recording invocations. To do so, this method should be given the desired instance to match, while the invocation to be recorded should be done on the available mocked instance, which must be a different one (otherwise a non-mocked method would get executed). This is valid only if the instance to be matched is assignable to the mocked type, and typically occurs when partially mocking a class hierarchy.

Returns:

the given mocked instance, allowing the invocation being recorded/verified to immediately follow the call to this method

See Also:

Tutorial

with

protected final <T> T with(Delegate<? super T> objectWithDelegateMethod)

Applies a custom argument matcher for a parameter in the current expectation.

The class of the given delegate object should define a single non-private delegate method (plus any number of helper private methods). The name of the delegate method doesn't matter, but it must have a single parameter capable of receiving the relevant argument values.

The return type of the delegate method should be boolean or void. In the first case, a return value of true will indicate a successful match for the actual invocation argument at replay time, while a return of false will fail to match the invocation. In the case of a void return type, the actual invocation argument should be validated through a suitable JUnit/TestNG assertion.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

objectWithDelegateMethod - an instance of a class defining a single non-private delegate method

Returns:

the default primitive value corresponding to T if it's a primitive wrapper type, or null otherwise

See Also:

withArgThat(org.hamcrest.Matcher), Tutorial

withAny

protected final <T> T withAny(T arg)

Same as withEqual(Object), but matching any argument value of the appropriate type.

Consider using instead the "anyXyz" field appropriate to the parameter type: anyBoolean, anyByte, anyChar, anyDouble, anyFloat, anyInt, anyLong, anyShort, anyString, or any for other reference types.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Note: when using Deencapsulation.invoke(Object, String, Object...), etc., it's valid to pass withAny(ParameterType.class) if an actual instance of the parameter type cannot be created.

Parameters:

arg - an arbitrary value which will match any argument value in the replay phase

Returns:

the input argument

See Also:

Tutorial

withArgThat

protected final <T> T withArgThat(org.hamcrest.Matcher<? super T> argumentMatcher)

Applies a Hamcrest argument matcher for a parameter in the current expectation.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

argumentMatcher - any org.hamcrest.Matcher object

Returns:

the value recorded inside the given Hamcrest matcher, or null if there is no such value to be found

See Also:

with(Delegate)

withCapture

protected final <T> T withCapture(List<T> valueHolderForMultipleInvocations)

Captures the argument value passed into the associated expectation parameter, for each invocation that matches the expectation when the tested code is exercised. As each such value is captured, it gets added to the given list so that it can be inspected later. Apart from capturing received argument values, this method has the same effect as the any argument matcher.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

valueHolderForMultipleInvocations - list into which the arguments received by matching invocations will be added

Returns:

the default value for type T

See Also:

Verifications.withCapture(), Verifications.withCapture(Object), Tutorial

withEqual

protected final double withEqual(double value,
                                 double delta)

Same as withEqual(Object), but checking that a numeric invocation argument in the replay phase is sufficiently close to the given value.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

value - the center value for range comparison

delta - the tolerance around the center value, for a range of [value - delta, value + delta]

Returns:

the given value

See Also:

Tutorial

withEqual

protected final float withEqual(float value,
                                double delta)

Same as withEqual(Object), but checking that a numeric invocation argument in the replay phase is sufficiently close to the given value.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

value - the center value for range comparison

delta - the tolerance around the center value, for a range of [value - delta, value + delta]

Returns:

the given value

See Also:

Tutorial

withEqual

protected final <T> T withEqual(T arg)

When passed as argument for an expectation, creates a new matcher that will check if the given value is equal to the corresponding argument received by a matching invocation.

The matcher is added to the end of the list of argument matchers for the invocation being recorded/verified. It cannot be reused for a different parameter.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(value) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Usually, this particular method should not be used. Instead, simply pass the desired argument value directly, without any matcher. Only when specifying values for a varargs method it's useful, and even then only when some other argument matcher is also used.

Parameters:

arg - the expected argument value

Returns:

the given argument

See Also:

Tutorial

withInstanceLike

protected final <T> T withInstanceLike(T object)

Same as withEqual(Object), but checking that an invocation argument in the replay phase is an instance of the same class as the given object.

Equivalent to a withInstanceOf(object.getClass()) call, except that it returns object instead of null.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

object - an instance of the desired class

Returns:

the given instance

See Also:

Tutorial

withInstanceOf

protected final <T> T withInstanceOf(Class<T> argClass)

Same as withEqual(Object), but checking that an invocation argument in the replay phase is an instance of the given class.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

argClass - the desired class

Returns:

always null; if you need a specific return value, use withInstanceLike(Object)

See Also:

Tutorial

withMatch

protected final <T extends CharSequence> T withMatch(T regex)

Same as withEqual(Object), but checking that a textual invocation argument in the replay phase matches the given regular expression.

Note that this can be used for any string comparison, including case insensitive ones (with "(?i)" in the regex).

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

regex - an arbitrary (non-null) regular expression against which textual argument values will be matched

Returns:

the given regex

See Also:

Pattern.compile(String, int), Tutorial

withNotEqual

protected final <T> T withNotEqual(T arg)

Same as withEqual(Object), but checking that the invocation argument in the replay phase is different from the given value.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

arg - an arbitrary value, but different from the ones expected to occur during replay

Returns:

the given argument value

See Also:

Tutorial

withNotNull

protected final <T> T withNotNull()

Same as withEqual(Object), but checking that an invocation argument in the replay phase is not null.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Returns:

always null

See Also:

Tutorial

withNull

protected final <T> T withNull()

Same as withEqual(Object), but checking that an invocation argument in the replay phase is null.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Returns:

always null

See Also:

Tutorial

withPrefix

protected final <T extends CharSequence> T withPrefix(T text)

Same as withEqual(Object), but checking that a textual invocation argument in the replay phase starts with the given text.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

text - an arbitrary non-null textual value

Returns:

the given text

See Also:

Tutorial

withSameInstance

protected final <T> T withSameInstance(T object)

Same as withEqual(Object), but checking that an invocation argument in the replay phase is the exact same instance as the one in the recorded/verified invocation.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

object - the desired instance

Returns:

the given object

See Also:

Tutorial

withSubstring

protected final <T extends CharSequence> T withSubstring(T text)

Same as withEqual(Object), but checking that a textual invocation argument in the replay phase contains the given text as a substring.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

text - an arbitrary non-null textual value

Returns:

the given text

See Also:

Tutorial

withSuffix

protected final <T extends CharSequence> T withSuffix(T text)

Same as withEqual(Object), but checking that a textual invocation argument in the replay phase ends with the given text.

When an argument matcher is used for a regular (ie, non-varargs) parameter in a call to a mocked method/constructor, it's not necessary to also use matchers for the other parameters. So, it's valid to mix the use of matchers with given values. Any arguments given as literals, local variables, or fields, will be implicitly matched as if withEqual(Object) had been used. In the special case of a varargs method, however, this flexibility is not available: if a matcher is used for any regular parameter, or for any element in the varargs array, then a matcher must be used for every other parameter and varargs element.

Parameters:

text - an arbitrary non-null textual value

Returns:

the given text

See Also:

Tutorial