JUnitModelCallback


1   /*BEGIN_COPYRIGHT_BLOCK
2    *
3    * This file is part of DrJava.  Download the current version of this project from http://www.drjava.org/
4    * or http://sourceforge.net/projects/drjava/
5    *
6    * DrJava Open Source License
7    * 
8    * Copyright (C) 2001-2005 JavaPLT group at Rice University (javaplt@rice.edu).  All rights reserved.
9    *
10   * Developed by:   Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11   * 
12   * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
13   * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14   * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
15   * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16   * 
17   *     - Redistributions of source code must retain the above copyright notice, this list of conditions and the 
18   *       following disclaimers.
19   *     - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the 
20   *       following disclaimers in the documentation and/or other materials provided with the distribution.
21   *     - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to 
22   *       endorse or promote products derived from this Software without specific prior written permission.
23   *     - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their 
24   *       names without prior written permission from the JavaPLT group.  For permission, write to javaplt@rice.edu.
25   * 
26   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO 
27   * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
28   * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
29   * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
30   * WITH THE SOFTWARE.
31   * 
32   *END_COPYRIGHT_BLOCK*/
33  
34  package edu.rice.cs.drjava.model.junit;
35  
36  import java.io.File  ;
37  import edu.rice.cs.util.ClassPathVector;
38  import edu.rice.cs.util.classloader.ClassFileError;
39  
40  /** Callback interface which allows an JUnitModel to respond to tests running in a remote JVM.
41   * 
42   * @version $Id: JUnitModelCallback.java 3574 2006-03-06 04:21:44Z rcartwright $
43   */
44  public interface JUnitModelCallback {
45    
46    /** Called from the JUnitTestManager if its given className is not a test case.
47     *  @param isTestAll whether or not it was a use of the test all button
48     */
49    public void nonTestCase(boolean isTestAll);
50    
51   /** Called from the JUnitTestManager if it encounters an illegal class file.
52     *  @param e the ClassFileError object describing the error
53     */
54    public void classFileError(ClassFileError e);
55    
56    /** Called to indicate that a suite of tests has started running.
57     *  @param numTests The number of tests in the suite to be run.
58     */
59    public void testSuiteStarted(int numTests);
60    
61    /** Called when a particular test is started.
62     *  @param testName The name of the test being started.
63     */
64    public void testStarted(String   testName);
65    
66    /** Called when a particular test has ended.
67     *  @param testName The name of the test that has ended.
68     *  @param wasSuccessful Whether the test passed or not.
69     *  @param causedError If not successful, whether the test caused an error or simply failed.
70     */
71    public void testEnded(String   testName, boolean wasSuccessful, boolean causedError);
72    
73    /** Called when a full suite of tests has finished running.
74     *  @param errors The array of errors from all failed tests in the suite.
75     */
76    public void testSuiteEnded(JUnitError[] errors);
77    
78    /** Called when the JUnitTestManager wants to open a file that is not currently open.
79     *  @param className the name of the class for which we want to find the file
80     *  @return the file associated with the given class
81     */
82    public File   getFileForClassName(String   className);
83  
84    /** Returns the accumulated classpath in use by all Java interpreters, in the form of a ClassPathVector which has 
85     *  the correct toString()
86     */
87    public ClassPathVector getClassPath();
88  
89    /** Called when the JVM used for unit tests has registered. */
90    public void junitJVMReady();
91  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags