Java

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.GwtCompatible;
20

21
/**
22
 * An object that can perform a {@link #tearDown} operation.
23
 *
24
 * @author Kevin Bourrillion
25
 * @since 10.0
26
 */
27
@FunctionalInterface
28
@GwtCompatible
29
@ElementTypesAreNonnullByDefault
30
public interface TearDown {
31
  /**
32
   * Performs a <b>single</b> tear-down operation. See test-libraries-for-java's {@code
33
   * com.google.common.testing.junit3.TearDownTestCase} and {@code
34
   * com.google.common.testing.junit4.TearDownTestCase} for example.
35
   *
36
   * <p>A failing {@link TearDown} may or may not fail a tl4j test, depending on the version of
37
   * JUnit test case you are running under. To avoid failing in the face of an exception regardless
38
   * of JUnit version, implement a {@link SloppyTearDown} instead.
39
   *
40
   * <p>tl4j details: For backwards compatibility, {@code junit3.TearDownTestCase} currently does
41
   * not fail a test when an exception is thrown from one of its {@link TearDown} instances, but
42
   * this is subject to change. Also, {@code junit4.TearDownTestCase} will.
43
   *
44
   * @throws Exception for any reason. {@code TearDownTestCase} ensures that any exception thrown
45
   *     will not interfere with other TearDown operations.
46
   */
47
  void tearDown() throws Exception;
48
}
49