public abstract class BaseStubbing<T> extends Object implements OngoingStubbing<T>, DeprecatedOngoingStubbing<T>
| Constructor and Description |
|---|
BaseStubbing() |
| Modifier and Type | Method and Description |
|---|---|
OngoingStubbing<T> |
thenCallRealMethod()
Sets the real implementation to be called when the method is called on a mock object.
|
OngoingStubbing<T> |
thenReturn(T value)
Sets a return value to be returned when the method is called.
|
OngoingStubbing<T> |
thenReturn(T value,
T... values)
Sets consecutive return values to be returned when the method is called.
|
OngoingStubbing<T> |
thenThrow(Class<? extends Throwable> throwableType)
Sets a Throwable type to be thrown when the method is called.
|
OngoingStubbing<T> |
thenThrow(Class<? extends Throwable> toBeThrown,
Class<? extends Throwable>... nextToBeThrown)
Sets Throwable classes to be thrown when the method is called.
|
OngoingStubbing<T> |
thenThrow(Throwable... throwables)
Sets Throwable objects to be thrown when the method is called.
|
DeprecatedOngoingStubbing<T> |
toReturn(T value)
Set a return value for the stubbed method.
|
DeprecatedOngoingStubbing<T> |
toThrow(Throwable throwable)
Set a Throwable to be thrown when the stubbed method is called.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetMock, then, thenAnswertoAnswerpublic OngoingStubbing<T> thenReturn(T value)
OngoingStubbing
when(mock.someMethod()).thenReturn(10);
Mockito.when(T)thenReturn in interface OngoingStubbing<T>value - return valuepublic OngoingStubbing<T> thenReturn(T value, T... values)
OngoingStubbing
when(mock.someMethod()).thenReturn(1, 2, 3);
See examples in javadoc for Mockito.when(T)
thenReturn in interface OngoingStubbing<T>value - first return valuevalues - next return valuespublic OngoingStubbing<T> thenThrow(Throwable... throwables)
OngoingStubbing
when(mock.someMethod()).thenThrow(new RuntimeException());
You can specify throwables to be thrown for consecutive calls. In that case the last throwable determines the behavior of further consecutive calls.
If throwable is null then exception will be thrown.
See examples in javadoc for Mockito.when(T)
thenThrow in interface OngoingStubbing<T>throwables - to be thrown on method invocationpublic OngoingStubbing<T> thenThrow(Class<? extends Throwable> throwableType)
OngoingStubbing
when(mock.someMethod()).thenThrow(RuntimeException.class);
If the throwable class is a checked exception then it has to match one of the checked exceptions of the stubbed method signature.
If throwable is null then exception will be thrown.
See examples in javadoc for Mockito.when(T)
thenThrow in interface OngoingStubbing<T>throwableType - to be thrown on method invocationpublic OngoingStubbing<T> thenThrow(Class<? extends Throwable> toBeThrown, Class<? extends Throwable>... nextToBeThrown)
OngoingStubbing
when(mock.someMethod()).thenThrow(RuntimeException.class);
Each throwable class will be instantiated for each method invocation.
If throwableTypes contain a checked exception then it has to
match one of the checked exceptions of method signature.
You can specify throwableTypes to be thrown for consecutive calls.
In that case the last throwable determines the behavior of further consecutive calls.
If throwable is null then exception will be thrown.
See examples in javadoc for Mockito.when(T)
Note since JDK 7, invoking this method will raise a compiler warning "possible heap pollution",
this API is safe to use. If you don't want to see this warning it is possible to chain OngoingStubbing.thenThrow(Class)
thenThrow in interface OngoingStubbing<T>toBeThrown - to be thrown on method invocationnextToBeThrown - next to be thrown on method invocationpublic OngoingStubbing<T> thenCallRealMethod()
OngoingStubbingAs usual you are going to read the partial mock warning: Object oriented programming is more less tackling complexity by dividing the complexity into separate, specific, SRPy objects. How does partial mock fit into this paradigm? Well, it just doesn't... Partial mock usually means that the complexity has been moved to a different method on the same object. In most cases, this is not the way you want to design your application.
However, there are rare cases when partial mocks come handy: dealing with code you cannot change easily (3rd party interfaces, interim refactoring of legacy code etc.) However, I wouldn't use partial mocks for new, test-driven & well-designed code.
// someMethod() must be safe (e.g. doesn't throw, doesn't have dependencies to the object state, etc.)
// if it isn't safe then you will have trouble stubbing it using this api. Use Mockito.doCallRealMethod() instead.
when(mock.someMethod()).thenCallRealMethod();
// calls real method:
mock.someMethod();
Mockito.spy(Object) to find out more about partial mocks.
Mockito.spy() is a recommended way of creating partial mocks.
The reason is it guarantees real methods are called against correctly constructed object because you're responsible for constructing the object passed to spy() method.
See examples in javadoc for Mockito.when(T)
thenCallRealMethod in interface OngoingStubbing<T>public DeprecatedOngoingStubbing<T> toReturn(T value)
DeprecatedOngoingStubbing
stub(mock.someMethod()).toReturn(10);
Mockito.stub(T)toReturn in interface DeprecatedOngoingStubbing<T>value - return valuepublic DeprecatedOngoingStubbing<T> toThrow(Throwable throwable)
DeprecatedOngoingStubbing
stub(mock.someMethod()).toThrow(new RuntimeException());
Mockito.stub(T)toThrow in interface DeprecatedOngoingStubbing<T>throwable - to be thrown on method invocation