org.mockito.MockedStatic Maven / Gradle / Ivy
Show all versions of mockito-core Show documentation
/*
* Copyright (c) 2007 Mockito contributors
* This program is made available under the terms of the MIT License.
*/
package org.mockito;
import static org.mockito.Mockito.times;
import org.mockito.stubbing.OngoingStubbing;
import org.mockito.verification.VerificationMode;
/**
* Represents an active mock of a type's static methods. The mocking only affects the thread
* on which this static mock was created and it is not safe to use this object from another
* thread. The static mock is released when this object's {@link MockedStatic#close()} method
* is invoked. If this object is never closed, the static mock will remain active on the
* initiating thread. It is therefore recommended to create this object within a try-with-resources
* statement unless when managed explicitly, for example by using a JUnit rule or extension.
*
* If the {@link Mock} annotation is used on fields or method parameters of this type, a static mock
* is created instead of a regular mock. The static mock is activated and released upon completing any
* relevant test.
*
* @param The type being mocked.
*/
public interface MockedStatic extends ScopedMock {
/**
* See {@link Mockito#when(Object)}.
*/
OngoingStubbing when(Verification verification);
/**
* See {@link Mockito#verify(Object)}.
*/
default void verify(Verification verification) {
verify(verification, times(1));
}
/**
* See {@link Mockito#verify(Object, VerificationMode)}.
*/
void verify(Verification verification, VerificationMode mode);
/**
* See {@link Mockito#reset(Object[])}.
*/
void reset();
/**
* See {@link Mockito#clearInvocations(Object[])}.
*/
void clearInvocations();
/**
* {@link Mockito#verifyNoMoreInteractions(Object...)}.
*/
void verifyNoMoreInteractions();
/**
* See {@link Mockito#verifyNoInteractions(Object...)}.
*/
void verifyNoInteractions();
/**
* Functional interface for a verification operation on a static mock.
*/
@FunctionalInterface
interface Verification {
/**
* Apply the verification operation.
*
* @throws Throwable any exception that may be thrown.
*/
void apply() throws Throwable;
}
}