Package org.mockito.internal.creation.bytebuddy

Class ByteBuddyMockMaker

java.lang.Object

org.mockito.internal.creation.bytebuddy.ByteBuddyMockMaker

All Implemented Interfaces:

ClassCreatingMockMaker, MockMaker

public class ByteBuddyMockMaker
extends java.lang.Object
implements ClassCreatingMockMaker

ByteBuddy MockMaker. This class will serve as the programmatic entry point to all mockito internal MockMakers. Currently the default and only mock maker is the subclassing engine, but with enough feedback we can later promote the inlining engine for features like final class/methods mocks. The programmatic API could look like mock(Final.class, withSettings().finalClasses()).

Nested Class Summary

Nested classes/interfaces inherited from interface org.mockito.plugins.MockMaker

MockMaker.TypeMockability

Field Summary

Fields

Modifier and Type	Field	Description
private ClassCreatingMockMaker	defaultByteBuddyMockMaker

Constructor Summary

Constructors

Constructor	Description
ByteBuddyMockMaker()

Method Summary

Modifier and Type	Method	Description
<T> T	createMock(MockCreationSettings<T> settings, MockHandler handler)	If you want to provide your own implementation of MockMaker this method should: Create a proxy object that implements settings.typeToMock and potentially also settings.extraInterfaces. You may use the information from settings to create/configure your proxy object. Your proxy object should carry the handler with it.
<T> java.lang.Class<? extends T>	createMockType(MockCreationSettings<T> creationSettings)
MockHandler	getHandler(java.lang.Object mock)	Returns the handler for the mock.
MockMaker.TypeMockability	isTypeMockable(java.lang.Class<?> type)	Indicates if the given type can be mocked by this mockmaker.
void	resetMock(java.lang.Object mock, MockHandler newHandler, MockCreationSettings settings)	Replaces the existing handler on mock with newHandler.

Methods inherited from class java.lang.Object

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

Field Detail

defaultByteBuddyMockMaker

private ClassCreatingMockMaker defaultByteBuddyMockMaker

Constructor Detail

ByteBuddyMockMaker

public ByteBuddyMockMaker()

Method Detail

createMock

public <T> T createMock(MockCreationSettings<T> settings,
                        MockHandler handler)

Description copied from interface: MockMaker

If you want to provide your own implementation of MockMaker this method should:

• Create a proxy object that implements settings.typeToMock and potentially also settings.extraInterfaces.
• You may use the information from settings to create/configure your proxy object.
• Your proxy object should carry the handler with it. For example, if you generate byte code to create the proxy you could generate an extra field to keep the handler with the generated object. Your implementation of MockMaker is required to provide this instance of handler when MockMaker.getHandler(Object) is called.

Specified by:

createMock in interface MockMaker

Type Parameters:

T - Type of the mock to return, actually the settings.getTypeToMock.

Parameters:

settings - Mock creation settings like type to mock, extra interfaces and so on.

handler - See MockHandler. Do not provide your own implementation at this time. Make sure your implementation of MockMaker.getHandler(Object) will return this instance.

Returns:

The mock instance.

createMockType

public <T> java.lang.Class<? extends T> createMockType(MockCreationSettings<T> creationSettings)

Specified by:

createMockType in interface ClassCreatingMockMaker

getHandler

public MockHandler getHandler(java.lang.Object mock)

Description copied from interface: MockMaker

Returns the handler for the mock. Do not provide your own implementations at this time because the work on the MockHandler api is not completed. Use the instance provided to you by Mockito at MockMaker.createMock(org.mockito.mock.MockCreationSettings<T>, org.mockito.invocation.MockHandler) or MockMaker.resetMock(java.lang.Object, org.mockito.invocation.MockHandler, org.mockito.mock.MockCreationSettings).

Specified by:

getHandler in interface MockMaker

Parameters:

mock - The mock instance.

Returns:

The mock handler, but may return null - it means that there is no handler attached to provided object. This means the passed object is not really a Mockito mock.

resetMock

public void resetMock(java.lang.Object mock,
                      MockHandler newHandler,
                      MockCreationSettings settings)

Description copied from interface: MockMaker

Replaces the existing handler on mock with newHandler.

The invocation handler actually store invocations to achieve stubbing and verification. In order to reset the mock, we pass a new instance of the invocation handler.

Your implementation should make sure the newHandler is correctly associated to passed mock

Specified by:

resetMock in interface MockMaker

Parameters:

mock - The mock instance whose invocation handler is to be replaced.

newHandler - The new invocation handler instance.

settings - The mock settings - should you need to access some of the mock creation details.

isTypeMockable

@Incubating
public MockMaker.TypeMockability isTypeMockable(java.lang.Class<?> type)

Description copied from interface: MockMaker

Indicates if the given type can be mocked by this mockmaker.

Mockmaker may have different capabilities in term of mocking, typically Mockito 1.x's internal mockmaker cannot mock final types. Other implementations, may have different limitations.

Specified by:

isTypeMockable in interface MockMaker

Parameters:

type - The type inspected for mockability.

Returns:

object that carries the information about mockability of given type.