• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2008 The Guava Authors
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.google.common.testing;
18 
19 import com.google.common.annotations.Beta;
20 import com.google.common.annotations.GwtCompatible;
21 
22 /**
23  * An object that can perform a {@link #tearDown} operation.
24  *
25  * @author Kevin Bourrillion
26  * @since 10.0
27  */
28 @Beta
29 @FunctionalInterface
30 @GwtCompatible
31 public interface TearDown {
32   /**
33    * Performs a <b>single</b> tear-down operation. See test-libraries-for-java's {@code
34    * com.google.common.testing.junit3.TearDownTestCase} and {@code
35    * com.google.common.testing.junit4.TearDownTestCase} for example.
36    *
37    * <p>A failing {@link TearDown} may or may not fail a tl4j test, depending on the version of
38    * JUnit test case you are running under. To avoid failing in the face of an exception regardless
39    * of JUnit version, implement a {@link SloppyTearDown} instead.
40    *
41    * <p>tl4j details: For backwards compatibility, {@code junit3.TearDownTestCase} currently does
42    * not fail a test when an exception is thrown from one of its {@link TearDown} instances, but
43    * this is subject to change. Also, {@code junit4.TearDownTestCase} will.
44    *
45    * @throws Exception for any reason. {@code TearDownTestCase} ensures that any exception thrown
46    *     will not interfere with other TearDown operations.
47    */
tearDown()48   void tearDown() throws Exception;
49 }
50