org.junit.jupiter.api.extension.BeforeEachCallback Maven / Gradle / Ivy
Show all versions of junit-jupiter-api Show documentation
/*
* Copyright 2015-2018 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junit.jupiter.api.extension;
import static org.apiguardian.api.API.Status.STABLE;
import org.apiguardian.api.API;
/**
* {@code BeforeEachCallback} defines the API for {@link Extension Extensions}
* that wish to provide additional behavior to tests before each test is invoked.
*
* In this context, the term test refers to the actual test method
* plus any user defined setup methods (e.g.,
* {@link org.junit.jupiter.api.BeforeEach @BeforeEach} methods).
*
*
Concrete implementations often implement {@link AfterEachCallback} as well.
*
*
Constructor Requirements
*
* Consult the documentation in {@link Extension} for details on
* constructor requirements.
*
* @since 5.0
* @see org.junit.jupiter.api.BeforeEach
* @see AfterEachCallback
* @see BeforeTestExecutionCallback
* @see AfterTestExecutionCallback
* @see BeforeAllCallback
* @see AfterAllCallback
*/
@FunctionalInterface
@API(status = STABLE, since = "5.0")
public interface BeforeEachCallback extends Extension {
/**
* Callback that is invoked before each test is invoked.
*
* @param context the current extension context; never {@code null}
*/
void beforeEach(ExtensionContext context) throws Exception;
}