KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > lib > cvsclient > event > ModuleExpansionEvent


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.lib.cvsclient.event;
21
22 /**
23  * This event is really intended only for the use in the Checkout command.
24  * During a checkout command, the client must ask the server to expand modules
25  * to determine whether there are aliases defined for a particular module.
26  * The client must then use the expansion to determine if a local directory
27  * exists and if so, send appropriate Modified requests etc.
28  * @author Robert Greig
29  */
30 public class ModuleExpansionEvent extends CVSEvent {
31     /**
32      * The expanded module name
33      */
34     private String JavaDoc module;
35
36     /**
37      * Creates new ModuleExpansionEvent.
38      * @param source the source of the event
39      * @param theModule the module name that the original request has been
40      * "expanded" to.
41      */
42     public ModuleExpansionEvent(Object JavaDoc source, String JavaDoc module) {
43         super(source);
44         this.module = module;
45     }
46
47     /**
48      * Get the module name that the original module name has been expanded to.
49      * @return the expanded name
50      */
51     public String JavaDoc getModule() {
52         return module;
53     }
54
55     /**
56      * Fire the event to the event listener. Subclasses should call the
57      * appropriate method on the listener to dispatch this event.
58      * @param listener the event listener
59      */
60     protected void fireEvent(CVSListener listener) {
61         listener.moduleExpanded(this);
62     }
63 }
64
Popular Tags