JUnitModel


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.IOException  ;
37  import java.io.File  ;
38  import java.util.List  ;
39  import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
40  import edu.rice.cs.util.text.SwingDocument;
41  
42  public interface JUnitModel {
43    
44    //-------------------------- Field Setters --------------------------------//
45    
46    
47    /** set the forceTestSuffix flag that forces class names in projects to end in "Test */
48    public void setForceTestSuffix(boolean b);
49  
50    //-------------------------- Listener Management --------------------------//
51  
52    /** Add a JUnitListener to the model.
53     *  @param listener a listener that reacts to JUnit events
54     */
55    public void addListener(JUnitListener listener);
56  
57    /** Remove a JUnitListener from the model.  If the listener is not currently listening to this 
58     *  model, this method has no effect.
59     * @param listener a listener that reacts to JUnit events
60     */
61    public void removeListener(JUnitListener listener);
62  
63    /** Removes all JUnitListeners from this model. */
64    public void removeAllListeners();
65  
66    //-------------------------------- Triggers --------------------------------//
67  
68    /** This is used by test cases and perhaps other things.  We should kill it. */
69    public SwingDocument getJUnitDocument();
70  
71    /** Creates a JUnit test suite over all currently open documents and runs it.  If the class file 
72     *  associated with a file is not a test case, it will be ignored.  Synchronized against the compiler 
73     *  model to prevent testing and compiling at the same time, which would create invalid results.
74     */
75    public void junitAll();
76  
77    /** Creates a JUnit test suite over all currently open project documents and runs it.  If 
78     *  the class file associated with a file is not a test case, it will be ignored.  Synchronized 
79     *  against the compiler model to prevent testing and compiling at the same time, which would 
80     *  create invalid results.
81     */
82    public void junitProject();
83  
84    /** Runs JUnit over a list of documents.  Synchronized against the compiler model to prevent 
85     *  testing and compiling at the same time, which would create invalid results.
86     *  @param lod the list of documents that are to be run through JUnit testing.
87     */
88    public void junitDocs(List  <OpenDefinitionsDocument> lod);
89    
90    /** Runs JUnit over a single document.  Synchronized against the compiler model to prevent testing
91     *  and compiling at the same time, which would create invalid results.
92     *  @param doc the document to be run under JUnit
93     */
94    public void junit(OpenDefinitionsDocument doc) throws ClassNotFoundException  , IOException  ;
95  
96    /** Forwards the classnames and files to the test manager to test all of them.
97     *  @param qualifiedClassnames a list of all the qualified class names to test.
98     *  @param files a list of their source files in the same order as qualified class names.
99     */
100   public void junitClasses(List  <String  > qualifiedClassnames, List  <File  > files);
101   
102   //---------------------------- Model Callbacks ----------------------------//
103   
104   /** Cleans up an attempt JUnit test exeuction when suitable test code is not available.
105    *  @param isTestAll whether or not it was a use of the test all button
106    */
107   public void nonTestCase(boolean isTestAll);
108   
109   //----------------------------- Error Results -----------------------------//
110 
111   /** Gets the JUnitErrorModel, which contains error info for the last test run. */
112   public JUnitErrorModel getJUnitErrorModel();
113 
114   /** Resets the junit error state to have no errors. */
115   public void resetJUnitErrors();
116   
117 }
118
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags