01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.modules.vmd.api.model;
42:
43: import java.util.Collection;
44:
45: /**
46: * This interface is used for notifying and processing event firing.
47: * For registering the implemenation see AccessControllerFactory interface.
48: * <p>
49: * Event firing is following these steps: For all registered AccessController classes a writeAccess method is called
50: * by nested calls (passing the calls using Runnable). In the deepest Runnable: notifyEventFiring method is called
51: * on all registered AccessController classes, then performed all event firing for all listeners, and finally
52: * notifyEventFired method is called on all registered AccessController classes.
53: * <p>
54: * This interface is used to listen on document change and you need to lock additional lock or mutex
55: * or some initialization/finalization code must performed before/after the event firing.
56: * <p>
57: * NOTE: Be aware that the creation of this class is called when a DesignDocument is creating,
58: * do not perform any action which may call/use DesignDocument since the document is not initialized yet.
59: *
60: * @author David Kaspar
61: */
62: public interface AccessController {
63:
64: /**
65: * Called when the event-firing is going to happen. The firing is performed by a Runnable.
66: * Using this method you are able to wrap the runnable code into your and perform your code before and after.
67: * Usually this is used for performing event firing in write access on a mutex.
68: * <p>
69: * Note: Runnable.run method that is passed as an argument must be executed exactly once.
70: * @param runnable the runnable
71: */
72: public void writeAccess(Runnable runnable);
73:
74: /**
75: * This is called immediately before an event is fired. At that time writeAccess method is called on all AccessControllers.
76: * @param event the event that is going to be fired
77: */
78: public void notifyEventFiring(DesignEvent event);
79:
80: /**
81: * This is called immediately after an event is fired. At that time writeAccess method is called on all AccessControllers.
82: * @param event the event that was fired
83: */
84: public void notifyEventFired(DesignEvent event);
85:
86: /**
87: * This is called during event firing process to notify that new components are created in a document.
88: * At the time of this method is called, all presenters are notified about their removing/adding and no event is fired
89: * to any design listener yet.
90: * @param createdComponents the newly created components
91: */
92: public void notifyComponentsCreated(
93: Collection<DesignComponent> createdComponents);
94:
95: }
|