001/*
002 * Copyright (C) 2008 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.testing;
018
019import com.google.common.annotations.Beta;
020import com.google.common.annotations.GwtCompatible;
021
022/**
023 * An object that can perform a {@link #tearDown} operation.
024 *
025 * @author Kevin Bourrillion
026 * @since 10.0
027 */
028@Beta
029@FunctionalInterface
030@GwtCompatible
031public interface TearDown {
032  /**
033   * Performs a <b>single</b> tear-down operation. See test-libraries-for-java's {@code
034   * com.google.common.testing.junit3.TearDownTestCase} and {@code
035   * com.google.common.testing.junit4.TearDownTestCase} for example.
036   *
037   * <p>A failing {@link TearDown} may or may not fail a tl4j test, depending on the version of
038   * JUnit test case you are running under. To avoid failing in the face of an exception regardless
039   * of JUnit version, implement a {@link SloppyTearDown} instead.
040   *
041   * <p>tl4j details: For backwards compatibility, {@code junit3.TearDownTestCase} currently does
042   * not fail a test when an exception is thrown from one of its {@link TearDown} instances, but
043   * this is subject to change. Also, {@code junit4.TearDownTestCase} will.
044   *
045   * @throws Exception for any reason. {@code TearDownTestCase} ensures that any exception thrown
046   *     will not interfere with other TearDown operations.
047   */
048  void tearDown() throws Exception;
049}