Package | Description |
---|---|
org.mockito |
Mockito is a mock library for java - see
Mockito class for usage. |
org.mockito.invocation |
Public API related to mock method invocations.
|
org.mockito.junit |
Mockito JUnit integration ; rule and runners.
|
org.mockito.listeners |
Public classes relative to the listener APIs.
|
org.mockito.mock |
Mock settings related classes.
|
org.mockito.plugins |
Mockito plugins allow customization of behavior.
|
org.mockito.quality |
Mocking quality related classes.
|
org.mockito.session | |
org.mockito.stubbing |
Stubbing related classes.
|
org.mockito.verification |
Verification related classes.
|
Modifier and Type | Interface and Description |
---|---|
interface |
MockedConstruction<T>
Represents a mock of any object construction of the represented type.
|
interface |
MockedStatic<T>
Represents an active mock of a type's static methods.
|
interface |
MockitoFramework
Mockito framework settings and lifecycle listeners, for advanced users or for integrating with other frameworks.
|
interface |
MockitoSession
MockitoSession is an optional, highly recommended feature
that helps driving cleaner tests by eliminating boilerplate code and adding extra validation. |
interface |
ScopedMock
Represents a mock with a thread-local explicit scope.
|
Modifier and Type | Method and Description |
---|---|
MockitoFramework |
MockitoFramework.addListener(MockitoListener listener)
Adds listener to Mockito.
|
static <T,A> Answer<T> |
AdditionalAnswers.answer(Answer1<T,A> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <T,A,B> Answer<T> |
AdditionalAnswers.answer(Answer2<T,A,B> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <T,A,B,C> Answer<T> |
AdditionalAnswers.answer(Answer3<T,A,B,C> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <T,A,B,C,D> |
AdditionalAnswers.answer(Answer4<T,A,B,C,D> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <T,A,B,C,D,E> |
AdditionalAnswers.answer(Answer5<T,A,B,C,D,E> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <T,A,B,C,D,E,F> |
AdditionalAnswers.answer(Answer6<T,A,B,C,D,E,F> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
idiomatically in Java 8
|
static <T> Answer<T> |
AdditionalAnswers.answersWithDelay(long sleepyTime,
Answer<T> answer)
Returns an answer after a delay with a defined length.
|
static <A> Answer<Void> |
AdditionalAnswers.answerVoid(VoidAnswer1<A> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <A,B> Answer<Void> |
AdditionalAnswers.answerVoid(VoidAnswer2<A,B> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <A,B,C> Answer<Void> |
AdditionalAnswers.answerVoid(VoidAnswer3<A,B,C> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <A,B,C,D> Answer<Void> |
AdditionalAnswers.answerVoid(VoidAnswer4<A,B,C,D> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <A,B,C,D,E> |
AdditionalAnswers.answerVoid(VoidAnswer5<A,B,C,D,E> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
ideally in Java 8
|
static <A,B,C,D,E,F> |
AdditionalAnswers.answerVoid(VoidAnswer6<A,B,C,D,E,F> answer)
Creates an answer from a functional interface - allows for a strongly typed answer to be created
idiomatically in Java 8
|
<T> MockCreationSettings<T> |
MockSettings.build(Class<T> typeToMock)
Creates immutable view of mock settings used later by Mockito.
|
<T> MockCreationSettings<T> |
MockSettings.buildStatic(Class<T> classToMock)
Creates immutable view of mock settings used later by Mockito, for use within a static mocking.
|
void |
MockitoFramework.clearInlineMock(Object mock)
Clears up internal state of specific inline mock.
|
void |
MockitoFramework.clearInlineMocks()
Clears up internal state of all inline mocks.
|
void |
MockitoSession.finishMocking()
Must be invoked when the user is done with mocking for given session (test method).
|
void |
MockitoSession.finishMocking(Throwable failure)
Must be invoked when the user is done with mocking for given session (test method).
|
static MockitoFramework |
Mockito.framework()
For advanced users or framework integrators.
|
InvocationFactory |
MockitoFramework.getInvocationFactory()
Returns a factory that can create instances of
Invocation . |
MockHandler |
MockingDetails.getMockHandler()
Returns the
MockHandler associated with this mock object. |
MockitoPlugins |
MockitoFramework.getPlugins()
Returns an object that has access to Mockito plugins.
|
static LenientStubber |
Mockito.lenient()
Lenient stubs bypass "strict stubbing" validation (see
Strictness.STRICT_STUBS ). |
MockSettings |
MockSettings.lenient()
Lenient mocks bypass "strict stubbing" validation (see
Strictness.STRICT_STUBS ). |
static <T> MockedConstruction<T> |
Mockito.mockConstruction(Class<T> classToMock)
Creates a thread-local mock controller for all constructions of the given class.
|
static <T> MockedConstruction<T> |
Mockito.mockConstruction(Class<T> classToMock,
java.util.function.Function<MockedConstruction.Context,MockSettings> mockSettingsFactory)
Creates a thread-local mock controller for all constructions of the given class.
|
static <T> MockedConstruction<T> |
Mockito.mockConstruction(Class<T> classToMock,
java.util.function.Function<MockedConstruction.Context,MockSettings> mockSettingsFactory,
MockedConstruction.MockInitializer<T> mockInitializer)
Creates a thread-local mock controller for all constructions of the given class.
|
static <T> MockedConstruction<T> |
Mockito.mockConstruction(Class<T> classToMock,
MockedConstruction.MockInitializer<T> mockInitializer)
Creates a thread-local mock controller for all constructions of the given class.
|
static <T> MockedConstruction<T> |
Mockito.mockConstruction(Class<T> classToMock,
MockSettings mockSettings)
Creates a thread-local mock controller for all constructions of the given class.
|
static <T> MockedConstruction<T> |
Mockito.mockConstruction(Class<T> classToMock,
MockSettings mockSettings,
MockedConstruction.MockInitializer<T> mockInitializer)
Creates a thread-local mock controller for all constructions of the given class.
|
static <T> MockedConstruction<T> |
Mockito.mockConstructionWithAnswer(Class<T> classToMock,
Answer defaultAnswer,
Answer... additionalAnswers)
Creates a thread-local mock controller for all constructions of the given class.
|
static MockitoSessionBuilder |
Mockito.mockitoSession()
MockitoSession is an optional, highly recommended feature
that helps driving cleaner tests by eliminating boilerplate code and adding extra validation. |
static <T> MockedStatic<T> |
Mockito.mockStatic(Class<T> classToMock)
Creates a thread-local mock controller for all static methods of the given class or interface.
|
static <T> MockedStatic<T> |
Mockito.mockStatic(Class<T> classToMock,
Answer defaultAnswer)
Creates a thread-local mock controller for all static methods of the given class or interface.
|
static <T> MockedStatic<T> |
Mockito.mockStatic(Class<T> classToMock,
MockSettings mockSettings)
Creates a thread-local mock controller for all static methods of the given class or interface.
|
static <T> MockedStatic<T> |
Mockito.mockStatic(Class<T> classToMock,
String name)
Creates a thread-local mock controller for all static methods of the given class or interface.
|
MockSettings |
MockSettings.outerInstance(Object outerClassInstance)
Makes it possible to mock non-static inner classes in conjunction with
MockSettings.useConstructor(Object...) . |
MockitoFramework |
MockitoFramework.removeListener(MockitoListener listener)
When you add listener using
MockitoFramework.addListener(MockitoListener) make sure to remove it. |
void |
MockitoSession.setStrictness(Strictness strictness)
Changes the strictness of this
MockitoSession . |
static <T> T |
Mockito.spy(Class<T> classToSpy)
Please refer to the documentation of
Mockito.spy(Object) . |
MockSettings |
MockSettings.useConstructor(Object... args)
Mockito attempts to use constructor when creating instance of the mock.
|
MockSettings |
MockSettings.verificationStartedListeners(VerificationStartedListener... listeners)
Registers a listener(s) that will be notified when user starts verification.
|
MockSettings |
MockSettings.withoutAnnotations()
By default, Mockito makes an attempt to preserve all annotation meta data on the mocked
type and its methods to mirror the mocked type as closely as possible.
|
Modifier and Type | Interface and Description |
---|---|
interface |
InvocationContainer
Although this class is a part of public API, please don't provide your own implementations.
|
interface |
InvocationFactory
Available via
MockitoFramework.getInvocationFactory() . |
Modifier and Type | Method and Description |
---|---|
Invocation |
InvocationFactory.createInvocation(Object target,
MockCreationSettings settings,
Method method,
InvocationFactory.RealMethodBehavior realMethod,
Object... args)
Creates instance of an
Invocation object. |
InvocationContainer |
MockHandler.getInvocationContainer()
Returns the object that holds all invocations on the mock object,
including stubbings with declared answers.
|
MockCreationSettings<T> |
MockHandler.getMockSettings()
Read-only settings the mock object was created with.
|
Modifier and Type | Interface and Description |
---|---|
interface |
VerificationCollector
Use this rule in order to collect multiple verification failures and report at once.
|
Modifier and Type | Method and Description |
---|---|
VerificationCollector |
VerificationCollector.assertLazily()
Enforce all verifications are performed lazily.
|
void |
VerificationCollector.collectAndReport()
Collect all lazily verified behaviour.
|
static VerificationCollector |
MockitoJUnit.collector()
Creates a rule instance that can perform lazy verifications.
|
MockitoTestRule |
MockitoTestRule.strictness(Strictness strictness)
Equivalent to
MockitoRule.strictness(Strictness) . |
MockitoRule |
MockitoRule.strictness(Strictness strictness)
The strictness, especially "strict stubs" (
Strictness.STRICT_STUBS )
helps debugging and keeping tests clean. |
Modifier and Type | Interface and Description |
---|---|
interface |
VerificationListener
This listener can be notified of verify invocations on a mock.
|
interface |
VerificationStartedEvent
The instance of this class is passed to
VerificationStartedListener . |
interface |
VerificationStartedListener
This listener gets notified when the user starts verification.
|
Modifier and Type | Method and Description |
---|---|
Object |
VerificationStartedEvent.getMock()
The mock object that will be used during verification.
|
void |
VerificationStartedListener.onVerificationStarted(VerificationStartedEvent event)
Triggered when the user calls
Mockito.verify() . |
void |
VerificationStartedEvent.setMock(Object mock)
Replaces existing mock object for verification with a different one.
|
Modifier and Type | Class and Description |
---|---|
class |
SerializableMode
Mock serializable style.
|
Modifier and Type | Method and Description |
---|---|
Object[] |
MockCreationSettings.getConstructorArgs()
Used when arguments should be passed to the mocked object's constructor, regardless of whether these
arguments are supplied directly, or whether they include the outer instance.
|
Object |
MockCreationSettings.getOuterClassInstance()
Used when mocking non-static inner classes in conjunction with
MockCreationSettings.isUsingConstructor() |
List<VerificationStartedListener> |
MockCreationSettings.getVerificationStartedListeners()
VerificationStartedListener instances attached to this mock,
see MockSettings.verificationStartedListeners(VerificationStartedListener...) |
boolean |
MockCreationSettings.isLenient()
Informs if the mock was created with "lenient" strictness, e.g.
|
boolean |
MockCreationSettings.isUsingConstructor()
Informs whether the mock instance should be created via constructor
|
Modifier and Type | Interface and Description |
---|---|
interface |
InlineMockMaker
Extension to
MockMaker for mock makers that changes inline method implementations
and need keep track of created mock objects. |
interface |
MemberAccessor
A member accessor is responsible for invoking methods, constructors and for setting
and reading field values.
|
interface |
MockitoLogger
Mockito logger.
|
static interface |
MockMaker.ConstructionMockControl<T> |
static interface |
MockMaker.StaticMockControl<T> |
static interface |
MockMaker.TypeMockability
Carries the mockability information
|
interface |
PluginSwitch
Allows switching off the plugins that are discovered on classpath.
|
Modifier and Type | Method and Description |
---|---|
void |
InlineMockMaker.clearAllMocks()
Cleans up internal state for all existing mocks.
|
void |
InlineMockMaker.clearMock(Object mock)
Clean up internal state for specified
mock . |
default <T> MockMaker.ConstructionMockControl<T> |
MockMaker.createConstructionMock(Class<T> type,
java.util.function.Function<MockedConstruction.Context,MockCreationSettings<T>> settingsFactory,
java.util.function.Function<MockedConstruction.Context,MockHandler<T>> handlerFactory,
MockedConstruction.MockInitializer<T> mockInitializer)
If you want to provide your own implementation of
MockMaker this method should:
Intercept all constructions of the specified type in the current thread
Only intercept the construction after being enabled.
Stops the interception when disabled.
|
default <T> MockMaker.StaticMockControl<T> |
MockMaker.createStaticMock(Class<T> type,
MockCreationSettings<T> settings,
MockHandler handler)
If you want to provide your own implementation of
MockMaker this method should:
Alter the supplied class to only change its behavior in the current thread.
Only alters the static method's behavior after being enabled.
Stops the altered behavior when disabled.
|
MockMaker.TypeMockability |
MockMaker.isTypeMockable(Class<?> type)
Indicates if the given type can be mocked by this mockmaker.
|
void |
MockitoLogger.log(Object what)
Log specified object.
|
Modifier and Type | Class and Description |
---|---|
class |
Strictness
Configures the "strictness" of Mockito, affecting the behavior of stubbings and verification.
|
Modifier and Type | Interface and Description |
---|---|
interface |
MockitoSessionBuilder
Fluent builder interface for
MockitoSession objects. |
interface |
MockitoSessionLogger
Logger for hints emitted when
finishing mocking for a
MockitoSession . |
Modifier and Type | Method and Description |
---|---|
MockitoSessionBuilder |
MockitoSessionBuilder.initMocks(Object... testClassInstances)
Adds the test class instances for initialization of fields annotated with Mockito annotations
like
Mock . |
MockitoSessionBuilder |
MockitoSessionBuilder.initMocks(Object testClassInstance)
Adds the test class instance for initialization of fields annotated with Mockito annotations
like
Mock . |
void |
MockitoSessionLogger.log(String hint)
Logs the hint.
|
MockitoSessionBuilder |
MockitoSessionBuilder.logger(MockitoSessionLogger logger)
Configures logger used by
MockitoSession for emitting
warnings when finishing the session. |
MockitoSessionBuilder |
MockitoSessionBuilder.name(String name)
Configures the name of the
MockitoSession instance. |
MockitoSession |
MockitoSessionBuilder.startMocking()
Starts new mocking session! Creates new
MockitoSession instance to initialize the session. |
MockitoSessionBuilder |
MockitoSessionBuilder.strictness(Strictness strictness)
Configures strictness of
MockitoSession instance. |
Modifier and Type | Interface and Description |
---|---|
interface |
Answer1<T,A0>
Generic interface to be used for configuring mock's answer for a single argument invocation.
|
interface |
Answer2<T,A0,A1>
Generic interface to be used for configuring mock's answer for a two argument invocation.
|
interface |
Answer3<T,A0,A1,A2>
Generic interface to be used for configuring mock's answer for a three argument invocation.
|
interface |
Answer4<T,A0,A1,A2,A3>
Generic interface to be used for configuring mock's answer for a four argument invocation.
|
interface |
Answer5<T,A0,A1,A2,A3,A4>
Generic interface to be used for configuring mock's answer for a five argument invocation.
|
interface |
Answer6<T,A0,A1,A2,A3,A4,A5>
Generic interface to be used for configuring mock's answer for a six argument invocation.
|
interface |
ValidableAnswer
Allow to validate this answer is correct for the given invocation.
|
interface |
VoidAnswer1<A0>
Generic interface to be used for configuring mock's answer for a single argument invocation that returns nothing.
|
interface |
VoidAnswer2<A0,A1>
Generic interface to be used for configuring mock's answer for a two argument invocation that returns nothing.
|
interface |
VoidAnswer3<A0,A1,A2>
Generic interface to be used for configuring mock's answer for a three argument invocation that returns nothing.
|
interface |
VoidAnswer4<A0,A1,A2,A3>
Generic interface to be used for configuring mock's answer for a four argument invocation that returns nothing.
|
interface |
VoidAnswer5<A0,A1,A2,A3,A4>
Generic interface to be used for configuring mock's answer for a five argument invocation that returns nothing.
|
interface |
VoidAnswer6<A0,A1,A2,A3,A4,A5>
Generic interface to be used for configuring mock's answer for a six argument invocation that returns nothing.
|
Modifier and Type | Method and Description |
---|---|
Strictness |
Stubbing.getStrictness()
Informs about the
Strictness level of this stubbing. |
Modifier and Type | Interface and Description |
---|---|
interface |
VerificationEvent
Contains all information about a verification that has happened.
|