Home | History | Annotate | Download | only in testing
      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 @GwtCompatible
     30 public interface TearDown {
     31   /**
     32    * Performs a <b>single</b> tear-down operation. See test-libraries-for-java's
     33    * {@code com.google.common.testing.junit3.TearDownTestCase} and
     34    * {@code 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
     37    * the version of JUnit test case you are running under. To avoid failing in
     38    * the face of an exception regardless of JUnit version, implement a {@link
     39    * SloppyTearDown} instead.
     40    *
     41    * <p>tl4j details: For backwards compatibility, {@code
     42    * junit3.TearDownTestCase} currently does not fail a test when an exception
     43    * is thrown from one of its {@link TearDown}s, but this is subject to
     44    * change. Also, {@code junit4.TearDownTestCase} will.
     45    *
     46    * @throws Exception for any reason. {@code TearDownTestCase} ensures that
     47    *     any exception thrown will not interfere with other TearDown
     48    *     operations.
     49    */
     50   void tearDown() throws Exception;
     51 }
     52