Package org.mockito.internal.creation.bytebuddy

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

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

      • createSpy

        public <T> java.util.Optional<T> createSpy​(MockCreationSettings<T> settings,
                                           MockHandler handler,
                                           T object)
        Description copied from interface: MockMaker
        By implementing this method, a mock maker can optionally support the creation of spies where all fields are set within a constructor. This avoids problems when creating spies of classes that declare effectively final instance fields where setting field values from outside the constructor is prohibited.
        Specified by:
        createSpy 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.
        object - The object to spy upon.
        Returns:
        The spy instance, if this mock maker supports direct spy creation.

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

      • createStaticMock

        public <T> MockMaker.StaticMockControl<T> createStaticMock​(java.lang.Class<T> type,
                                                           MockCreationSettings<T> settings,
                                                           MockHandler handler)
        Description copied from interface: MockMaker
        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.
        Specified by:
        createStaticMock in interface MockMaker
        Type Parameters:
        T - Type of the mock to return, actually the settings.getTypeToMock.
        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:
        A control for the static mock.

      • createConstructionMock

        public <T> MockMaker.ConstructionMockControl<T> createConstructionMock​(java.lang.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)
        Description copied from interface: MockMaker
        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.
        Specified by:
        createConstructionMock in interface MockMaker
        Type Parameters:
        T - Type of the mock to return, actually the settings.getTypeToMock.
        settingsFactory - Factory for mock creation settings like type to mock, extra interfaces and so on.
        handlerFactory - Factory for settings. See MockHandler. Do not provide your own implementation at this time. Make sure your implementation of MockMaker.getHandler(Object) will return this instance.
        Returns:
        A control for the mocked construction.

      • clearAllCaches

        public void clearAllCaches()
        Description copied from interface: MockMaker
        Clears all cashes for mocked types and removes all byte code alterations, if possible.
        Specified by:
        clearAllCaches in interface MockMaker