KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > junit > JUnitListener


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.util.List JavaDoc;
37
38 import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
39 import edu.rice.cs.drjava.model.compiler.CompilerListener;
40
41 import edu.rice.cs.util.classloader.ClassFileError;
42
43 /**
44  * An interface for responding to events generated by the JUnitModel.
45  *
46  * @version $Id: JUnitListener.java 3758 2006-04-09 20:27:33Z rcartwright $
47  */
48 public interface JUnitListener {
49
50   /** Called when trying to test a non-TestCase class.
51    * @param isTestAll whether or not it was a use of the test all button
52    */
53   public void nonTestCase(boolean isTestAll);
54   
55   /** Called when JUnit encounters an illegal class file.
56    * @param e the error or exception thrown by loading and resolving f.
57    */
58   public void classFileError(ClassFileError e);
59
60   /** Called after JUnit is started by the GlobalModel. */
61   public void junitStarted();
62
63   /** Called when testing a specific list of classes given their source files. */
64   public void junitClassesStarted();
65   
66   /** Called to indicate that a suite of tests has started running.
67    * @param numTests The number of tests in the suite to be run.
68    */
69   public void junitSuiteStarted(int numTests);
70
71   /** Called when a particular test is started.
72    * @param name The name of the test being started.
73    */
74   public void junitTestStarted(String JavaDoc name);
75
76   /** Called when a particular test has ended.
77    * @param name The name of the test that has ended.
78    * @param wasSuccessful Whether the test passed or not.
79    * @param causedError If not successful, whether the test caused an error or simply failed.
80    */
81   public void junitTestEnded(String JavaDoc name, boolean wasSuccessful, boolean causedError);
82
83   /** Called after JUnit is finished running tests. */
84   public void junitEnded();
85   
86   /** Called to demand that all source files be in sync before running JUnit tests.
87    * It is up to the caller of this method to check if the documents are in sync
88    * using OpenDefinitionsDocument.checkIfClassFileInSync().
89    */
90   public void compileBeforeJUnit(final CompilerListener l);
91 }
Popular Tags