KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > model > JavadocEventNotifier


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-2006 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;
35
36 import java.io.File JavaDoc;
37
38 /**
39  * Keeps track of all listeners to a JavadocModel, and has the ability
40  * to notify them of some event.
41  * <p>
42  *
43  * This class has a specific role of managing JavadocListeners. Other
44  * classes with similar names use similar code to perform the same function for
45  * other interfaces, e.g. InteractionsEventNotifier and GlobalEventNotifier.
46  * These classes implement the appropriate interface definition so that they
47  * can be used transparently as composite packaging for a particular listener
48  * interface.
49  * <p>
50  *
51  * Components which might otherwise manage their own list of listeners use
52  * EventNotifiers instead to simplify their internal implementation. Notifiers
53  * should therefore be considered a private implementation detail of the
54  * components, and should not be used directly outside of the "host" component.
55  * <p>
56  *
57  * All methods in this class must use the synchronization methods
58  * provided by ReaderWriterLock. This ensures that multiple notifications
59  * (reads) can occur simultaneously, but only one thread can be adding
60  * or removing listeners (writing) at a time, and no reads can occur
61  * during a write.
62  * <p>
63  *
64  * <i>No</i> methods on this class should be synchronized using traditional
65  * Java synchronization!
66  * <p>
67  *
68  * @version $Id: JavadocEventNotifier.java 3901 2006-06-30 05:28:11Z rcartwright $
69  */
70 class JavadocEventNotifier extends EventNotifier<JavadocListener>
71     implements JavadocListener {
72
73   /** Called after Javadoc is started by the GlobalModel. */
74   public void javadocStarted() {
75     _lock.startRead();
76     try { for (JavadocListener jl: _listeners) { jl.javadocStarted(); } }
77     finally { _lock.endRead(); }
78   }
79
80   /** Called after Javadoc is finished.
81    * @param success whether the Javadoc operation generated proper output
82    * @param destDir if (success == true) the location where the output was
83    * generated, otherwise undefined (possibly null)
84    * @param allDocs Whether Javadoc was run for all open documents
85    */
86   public void javadocEnded(boolean success, File JavaDoc destDir, boolean allDocs) {
87     _lock.startRead();
88     try { for (JavadocListener jl: _listeners) { jl.javadocEnded(success, destDir, allDocs); } }
89     finally { _lock.endRead();}
90   }
91
92   /** Called before attempting Javadoc, to give users a chance to save.
93    * Do not continue with Javadoc if the user doesn't save!
94    */
95   public void saveBeforeJavadoc() {
96     _lock.startRead();
97     try { for (JavadocListener jl: _listeners) { jl.saveBeforeJavadoc(); } }
98     finally { _lock.endRead(); }
99   }
100 }
101
102
Popular Tags