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.
List<InvocationListener>	getInvocationListeners()	InvocationListener instances attached to this mock, see MockSettings.invocationListeners(InvocationListener...).
MockName	getMockName()	the name of this mock, as printed on verification errors; see MockSettings.name(java.lang.String).
Object	getOuterClassInstance()	Used when mocking non-static inner classes in conjunction with isUsingConstructor()
SerializableMode	getSerializableMode()
Object	getSpiedInstance()	the spied instance - needed for spies.
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()	Informs if the mock was created with "lenient" strictness, e.g.
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.

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

@Incubating
List<VerificationStartedListener> getVerificationStartedListeners()

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

Since:

2.11.0

isUsingConstructor

@Incubating
boolean isUsingConstructor()

Informs whether the mock instance should be created via constructor

Since:

1.10.12

getConstructorArgs

@Incubating
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

@Incubating
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

@Incubating
boolean isLenient()

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