Package org.mockito.internal.creation.settings

Class CreationSettings<T>

java.lang.Object

org.mockito.internal.creation.settings.CreationSettings<T>

All Implemented Interfaces:

Serializable, MockCreationSettings<T>

Direct Known Subclasses:

MockSettingsImpl

public class CreationSettings<T>
extends Object
implements MockCreationSettings<T>, Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Answer<Object>	defaultAnswer
protected Set<Class<?>>	extraInterfaces
protected Type	genericTypeToMock
protected List<InvocationListener>	invocationListeners
protected String	mockMaker
protected MockName	mockName
protected MockType	mockType
protected String	name
protected SerializableMode	serializableMode
protected Object	spiedInstance
protected Strictness	strictness
protected boolean	stripAnnotations
protected List<StubbingLookupListener>	stubbingLookupListeners
protected boolean	stubOnly
protected Class<T>	typeToMock
protected List<VerificationStartedListener>	verificationStartedListeners

Constructor Summary

Constructors

Constructor	Description
CreationSettings()
CreationSettings(CreationSettings copy)

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<Object>	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.
String	getName()
Object	getOuterClassInstance()	Used when mocking non-static inner classes in conjunction with MockCreationSettings.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()
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
CreationSettings<T>	setExtraInterfaces(Set<Class<?>> extraInterfaces)
CreationSettings<T>	setGenericTypeToMock(Type genericTypeToMock)
CreationSettings<T>	setMockName(MockName mockName)
void	setMockType(MockType mockType)
CreationSettings<T>	setSerializableMode(SerializableMode serializableMode)
CreationSettings<T>	setTypeToMock(Class<T> typeToMock)

Methods inherited from class java.lang.Object

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

Field Details

typeToMock

protected Class<T> typeToMock

genericTypeToMock

protected transient Type genericTypeToMock

extraInterfaces

protected Set<Class<?>> extraInterfaces

name

protected String name

spiedInstance

protected Object spiedInstance

defaultAnswer

protected Answer<Object> defaultAnswer

mockName

protected MockName mockName

serializableMode

protected SerializableMode serializableMode

invocationListeners

protected List<InvocationListener> invocationListeners

stubbingLookupListeners

protected List<StubbingLookupListener> stubbingLookupListeners

verificationStartedListeners

protected List<VerificationStartedListener> verificationStartedListeners

stubOnly

protected boolean stubOnly

stripAnnotations

protected boolean stripAnnotations

strictness

protected Strictness strictness

mockMaker

protected String mockMaker

mockType

protected MockType mockType

Constructor Details

CreationSettings

public CreationSettings()

CreationSettings

public CreationSettings(CreationSettings copy)

Method Details

getTypeToMock

public Class<T> getTypeToMock()

Description copied from interface: MockCreationSettings

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

Specified by:

getTypeToMock in interface MockCreationSettings<T>

setTypeToMock

public CreationSettings<T> setTypeToMock(Class<T> typeToMock)

setGenericTypeToMock

public CreationSettings<T> setGenericTypeToMock(Type genericTypeToMock)

getExtraInterfaces

public Set<Class<?>> getExtraInterfaces()

Description copied from interface: MockCreationSettings

the extra interfaces the mock object should implement.

Specified by:

getExtraInterfaces in interface MockCreationSettings<T>

setExtraInterfaces

public CreationSettings<T> setExtraInterfaces(Set<Class<?>> extraInterfaces)

getName

public String getName()

getSpiedInstance

public Object getSpiedInstance()

Description copied from interface: MockCreationSettings

the spied instance - needed for spies.

Specified by:

getSpiedInstance in interface MockCreationSettings<T>

getDefaultAnswer

public Answer<Object> getDefaultAnswer()

Description copied from interface: MockCreationSettings

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

Specified by:

getDefaultAnswer in interface MockCreationSettings<T>

getMockName

public MockName getMockName()

Description copied from interface: MockCreationSettings

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

Specified by:

getMockName in interface MockCreationSettings<T>

setMockName

public CreationSettings<T> setMockName(MockName mockName)

isSerializable

public boolean isSerializable()

Description copied from interface: MockCreationSettings

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

Specified by:

isSerializable in interface MockCreationSettings<T>

setSerializableMode

public CreationSettings<T> setSerializableMode(SerializableMode serializableMode)

getSerializableMode

public SerializableMode getSerializableMode()

Specified by:

getSerializableMode in interface MockCreationSettings<T>

Returns:

the serializable mode of this mock

getInvocationListeners

public List<InvocationListener> getInvocationListeners()

Description copied from interface: MockCreationSettings

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

Specified by:

getInvocationListeners in interface MockCreationSettings<T>

getVerificationStartedListeners

public List<VerificationStartedListener> getVerificationStartedListeners()

Description copied from interface: MockCreationSettings

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

Specified by:

getVerificationStartedListeners in interface MockCreationSettings<T>

getStubbingLookupListeners

public List<StubbingLookupListener> getStubbingLookupListeners()

Description copied from interface: MockCreationSettings

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.

Specified by:

getStubbingLookupListeners in interface MockCreationSettings<T>

isUsingConstructor

public boolean isUsingConstructor()

Description copied from interface: MockCreationSettings

Informs whether the mock instance should be created via constructor

Specified by:

isUsingConstructor in interface MockCreationSettings<T>

isStripAnnotations

public boolean isStripAnnotations()

Description copied from interface: MockCreationSettings

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

Specified by:

isStripAnnotations in interface MockCreationSettings<T>

getConstructorArgs

public Object[] getConstructorArgs()

Description copied from interface: MockCreationSettings

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.

Specified by:

getConstructorArgs in interface MockCreationSettings<T>

Returns:

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

getOuterClassInstance

public Object getOuterClassInstance()

Description copied from interface: MockCreationSettings

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

Specified by:

getOuterClassInstance in interface MockCreationSettings<T>

Returns:

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

isStubOnly

public boolean isStubOnly()

Description copied from interface: MockCreationSettings

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

Specified by:

isStubOnly in interface MockCreationSettings<T>

isLenient

public boolean isLenient()

Specified by:

isLenient in interface MockCreationSettings<T>

getStrictness

public Strictness getStrictness()

Description copied from interface: MockCreationSettings

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).

Specified by:

getStrictness in interface MockCreationSettings<T>

getMockMaker

public String getMockMaker()

Description copied from interface: MockCreationSettings

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

Specified by:

getMockMaker in interface MockCreationSettings<T>

See Also:

• MockSettings.mockMaker(String)

getGenericTypeToMock

public Type getGenericTypeToMock()

Description copied from interface: MockCreationSettings

The generic type of the mock, if any.

Specified by:

getGenericTypeToMock in interface MockCreationSettings<T>

getMockType

public MockType getMockType()

Description copied from interface: MockCreationSettings

Returns the MockType for the mock being created.

Specified by:

getMockType in interface MockCreationSettings<T>

See Also:

• MockType

setMockType

public void setMockType(MockType mockType)