Package org.mockito.mock

Interface MockCreationSettings<T>

All Known Implementing Classes:

CreationSettings, MockSettingsImpl

@NotExtensible
public interface MockCreationSettings<T>

Informs about the mock settings. An immutable view of MockSettings.

Method Summary

Modifier and Type	Method	Description
Object[]	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.
Answer<?>	getDefaultAnswer()	the default answer for this mock, see MockSettings.defaultAnswer(org.mockito.stubbing.Answer).
Set<Class<?>>	getExtraInterfaces()	the extra interfaces the mock object should implement.
Type	getGenericTypeToMock()	The generic type of the mock, if any.
List<InvocationListener>	getInvocationListeners()	InvocationListener instances attached to this mock, see MockSettings.invocationListeners(InvocationListener...).
String	getMockMaker()	Returns the MockMaker which shall be used to create the mock.
MockName	getMockName()	the name of this mock, as printed on verification errors; see MockSettings.name(java.lang.String).
MockType	getMockType()	Returns the MockType for the mock being created.
Object	getOuterClassInstance()	Used when mocking non-static inner classes in conjunction with isUsingConstructor()
SerializableMode	getSerializableMode()
Object	getSpiedInstance()	the spied instance - needed for spies.
Strictness	getStrictness()	Sets strictness level for the mock, e.g.
List<StubbingLookupListener>	getStubbingLookupListeners()	Returns StubbingLookupListener instances attached to this mock via MockSettings.stubbingLookupListeners(StubbingLookupListener...).
Class<T>	getTypeToMock()	Mocked type.
List<VerificationStartedListener>	getVerificationStartedListeners()	VerificationStartedListener instances attached to this mock, see MockSettings.verificationStartedListeners(VerificationStartedListener...)
boolean	isLenient()	Deprecated. Use getStrictness() instead.
boolean	isSerializable()	if the mock is serializable, see MockSettings.serializable().
boolean	isStripAnnotations()	Whether the mock should not make a best effort to preserve annotations.
boolean	isStubOnly()	Whether the mock is only for stubbing, i.e.
boolean	isUsingConstructor()	Informs whether the mock instance should be created via constructor

Method Details

getTypeToMock

Class<T> getTypeToMock()

Mocked type. An interface or class the mock should implement / extend.

getGenericTypeToMock

Type getGenericTypeToMock()

The generic type of the mock, if any.

getExtraInterfaces

Set<Class<?>> getExtraInterfaces()

the extra interfaces the mock object should implement.

getMockName

MockName getMockName()

the name of this mock, as printed on verification errors; see MockSettings.name(java.lang.String).

getDefaultAnswer

Answer<?> getDefaultAnswer()

the default answer for this mock, see MockSettings.defaultAnswer(org.mockito.stubbing.Answer).

getSpiedInstance

Object getSpiedInstance()

the spied instance - needed for spies.

isSerializable

boolean isSerializable()

if the mock is serializable, see MockSettings.serializable().

getSerializableMode

SerializableMode getSerializableMode()

Returns:

the serializable mode of this mock

isStubOnly

boolean isStubOnly()

Whether the mock is only for stubbing, i.e. does not remember parameters on its invocation and therefore cannot be used for verification

isStripAnnotations

boolean isStripAnnotations()

Whether the mock should not make a best effort to preserve annotations.

getStubbingLookupListeners

List<StubbingLookupListener> getStubbingLookupListeners()

Returns StubbingLookupListener instances attached to this mock via MockSettings.stubbingLookupListeners(StubbingLookupListener...). The resulting list is mutable, you can add/remove listeners even after the mock was created.

For more details see StubbingLookupListener.

Since:

2.24.6

getInvocationListeners

List<InvocationListener> getInvocationListeners()

InvocationListener instances attached to this mock, see MockSettings.invocationListeners(InvocationListener...).

getVerificationStartedListeners

List<VerificationStartedListener> getVerificationStartedListeners()

VerificationStartedListener instances attached to this mock, see MockSettings.verificationStartedListeners(VerificationStartedListener...)

Since:

2.11.0

isUsingConstructor

boolean isUsingConstructor()

Informs whether the mock instance should be created via constructor

Since:

1.10.12

getConstructorArgs

Object[] 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.

Returns:

An array of arguments that are passed to the mocked object's constructor. If getOuterClassInstance() is available, it is prepended to the passed arguments.

Since:

2.7.14

getOuterClassInstance

Object getOuterClassInstance()

Used when mocking non-static inner classes in conjunction with isUsingConstructor()

Returns:

the outer class instance used for creation of the mock object via the constructor.

Since:

1.10.12

isLenient

@Deprecated
boolean isLenient()

Deprecated.

Use getStrictness() instead. Informs if the mock was created with "lenient" strictness, e.g. having Strictness.LENIENT characteristic. For more information about using mocks with lenient strictness, see MockSettings.lenient().

Since:

2.20.0

getStrictness

Strictness getStrictness()

Sets strictness level for the mock, e.g. having Strictness.STRICT_STUBS characteristic. For more information about using mocks with custom strictness, see MockSettings.strictness(Strictness).

Since:

4.6.0

getMockMaker

String getMockMaker()

Returns the MockMaker which shall be used to create the mock. When the return value is null, the default shall be used.

Since:

4.8.0

See Also:

• MockSettings.mockMaker(String)

getMockType

MockType getMockType()

Returns the MockType for the mock being created.

Since:

5.9.0

See Also:

• MockType