View Javadoc

1   /*
2    * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
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  package de.smartics.testdoc.report.junit;
17  
18  import de.smartics.testdoc.core.doc.Type;
19  
20  /**
21   * Provides access to JUnit XML test case reports.
22   *
23   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
24   * @version $Revision:591 $
25   */
26  public interface JUnitTestCaseManager
27  {
28    // ********************************* Fields *********************************
29  
30    // --- constants ------------------------------------------------------------
31  
32    // ****************************** Initializer *******************************
33  
34    // ****************************** Inner Classes *****************************
35  
36    // ********************************* Methods ********************************
37  
38    // --- get&set --------------------------------------------------------------
39  
40    // --- business -------------------------------------------------------------
41  
42    /**
43     * Allows to selectively remove instances from the cache.
44     *
45     * @param testCaseType the test case instance to remove from the cache.
46     */
47    void evict(Type testCaseType);
48  
49    /**
50     * Removes all instances from the cache.
51     */
52    void clearCache();
53  
54  
55    /**
56     * Reads the test case for the given test case type.
57     *
58     * @param testCaseType the type of the test case to read.
59     * @return the information from the test case.
60     * @throws TestCaseReportException on any problem reading the test case.
61     */
62    JUnitTestCaseDoc readTestCase(Type testCaseType)
63      throws TestCaseReportException;
64  
65    // --- object basics --------------------------------------------------------
66  
67  }