KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > compiler > CompilerEventNotifier


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.compiler;
35
36 import java.io.File JavaDoc;
37 import java.util.List JavaDoc;
38
39 import edu.rice.cs.drjava.model.EventNotifier;
40
41 /**
42  * Keeps track of all listeners to a CompilerModel, and has the ability
43  * to notify them of some event.
44  * <p>
45  *
46  * This class has a specific role of managing CompilerListeners. Other
47  * classes with similar names use similar code to perform the same function for
48  * other interfaces, e.g. InteractionsEventNotifier and GlobalEventNotifier.
49  * These classes implement the appropriate interface definition so that they
50  * can be used transparently as composite packaging for a particular listener
51  * interface.
52  * <p>
53  *
54  * Components which might otherwise manage their own list of listeners use
55  * EventNotifiers instead to simplify their internal implementation. Notifiers
56  * should therefore be considered a private implementation detail of the
57  * components, and should not be used directly outside of the "host" component.
58  * <p>
59  *
60  * All methods in this class must use the synchronization methods
61  * provided by ReaderWriterLock. This ensures that multiple notifications
62  * (reads) can occur simultaneously, but only one thread can be adding
63  * or removing listeners (writing) at a time, and no reads can occur
64  * during a write.
65  * <p>
66  *
67  * <i>No</i> methods on this class should be synchronized using traditional
68  * Java synchronization!
69  * <p>
70  *
71  * @version $Id: CompilerEventNotifier.java 4044 2006-11-23 13:40:43Z dlsmith $
72  */
73 class CompilerEventNotifier extends EventNotifier<CompilerListener> implements CompilerListener {
74
75   /** Called after a compile is started by the GlobalModel. */
76   public void compileStarted() {
77 // new ScrollableDialog(null, "CompilerEventNotifier.compileStarted() called for listeners " + _listeners, "", "").show();
78 _lock.startRead();
79     try { for (CompilerListener cl : _listeners) { cl.compileStarted(); } }
80     finally { _lock.endRead(); }
81   }
82
83   /** Called when a compile has finished running. */
84   public void compileEnded(File JavaDoc workDir, List JavaDoc<? extends File JavaDoc> excludedFiles) {
85     _lock.startRead();
86     try { for (CompilerListener cl : _listeners) { cl.compileEnded(workDir, excludedFiles); } }
87     finally { _lock.endRead(); }
88   }
89
90   /** Called when files are saved before compiling. It is up to the caller of this method to check if the
91    * documents have been saved, using IGetDocuments.hasModifiedDocuments().
92    */
93   public void saveBeforeCompile() {
94     _lock.startRead();
95     try { for (CompilerListener cl : _listeners) { cl.saveBeforeCompile(); } }
96     finally { _lock.endRead(); }
97   }
98   
99   /** Called when files are saved before compiling. It is up to the caller of this method to check if the
100    * documents have been saved, using IGetDocuments.hasModifiedDocuments().
101    */
102   public void saveUntitled() {
103     _lock.startRead();
104     try { for (CompilerListener cl : _listeners) { cl.saveUntitled(); } }
105     finally { _lock.endRead(); }
106   }
107 }
108
Popular Tags