001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans;
043:
044: import java.util.logging.Level;
045: import org.openide.util.Utilities;
046: import java.util.*;
047:
048: /** Thread which fires changes in the modules.
049: * Used to separate property change events and
050: * lookup changes from the dynamic scope of the
051: * changes themselves. Also to batch up possible
052: * changes and avoid firing duplicates.
053: * Accepts changes at any time
054: * and fires them from within the mutex (as a reader).
055: * @author Jesse Glick
056: */
057: final class ChangeFirer {
058:
059: private final ModuleManager mgr;
060: // Pending things to perform:
061: private final Set<Change> changes = new LinkedHashSet<Change>(100);
062: private final Set<Module> modulesCreated = new HashSet<Module>(100);
063: private final Set<Module> modulesDeleted = new HashSet<Module>(10);
064:
065: /** Make a new change firer.
066: * @param mgr the associated module manager
067: */
068: public ChangeFirer(ModuleManager mgr) {
069: this .mgr = mgr;
070: }
071:
072: /** Add a change to the list of pending things to be fired.
073: * @param c the change which will be fired
074: */
075: public void change(Change c) {
076: changes.add(c);
077: }
078:
079: /** Add a module creation event to the list of pending things to be fired.
080: * @param m the module whose creation event will be fired
081: */
082: public void created(Module m) {
083: modulesCreated.add(m);
084: }
085:
086: /** Add a module deletion event to the list of pending things to be fired.
087: * Note that this will cancel any pending creation event for the same module!
088: * @param m the module whose creation event will be fired
089: */
090: public void deleted(Module m) {
091: // Possible that a module was added and then removed before any change
092: // was fired; in this case skip it.
093: if (!modulesCreated.remove(m)) {
094: modulesDeleted.add(m);
095: }
096: }
097:
098: /** Fire all pending changes.
099: * While this is happening, the manager is locked in a read-only mode.
100: * Should only be called from within a write mutex!
101: */
102: public void fire() {
103: mgr.readOnly(true);
104: try {
105: for (Change c : changes) {
106: if (c.source instanceof Module) {
107: ((Module) c.source).firePropertyChange0(c.prop,
108: c.old, c.nue);
109: } else if (c.source == mgr) {
110: mgr.firePropertyChange(c.prop, c.old, c.nue);
111: } else {
112: throw new IllegalStateException("Strange source: "
113: + c.source); // NOI18N
114: }
115: }
116: changes.clear();
117: if (!modulesCreated.isEmpty() || !modulesDeleted.isEmpty()) {
118: mgr.fireModulesCreatedDeleted(modulesCreated,
119: modulesDeleted);
120: }
121: modulesCreated.clear();
122: modulesDeleted.clear();
123: } catch (RuntimeException e) {
124: // Recover gracefully.
125: Util.err.log(Level.SEVERE, null, e);
126: } finally {
127: mgr.readOnly(false);
128: }
129: }
130:
131: /** Possible change event to be fired.
132: * Used instead of PropertyChangeEvent as it can be stored in a set.
133: */
134: public static final class Change {
135: public final String prop;
136: public final Object source, old, nue;
137:
138: public Change(Object source, String prop, Object old, Object nue) {
139: this .source = source;
140: this .prop = prop;
141: this .old = old;
142: this .nue = nue;
143: }
144:
145: // Semantic equality, to avoid duplicate changes:
146: public boolean equals(Object o) {
147: if (!(o instanceof Change))
148: return false;
149: Change c = (Change) o;
150: return Utilities.compareObjects(prop, c.prop)
151: && Utilities.compareObjects(source, c.source)
152: && Utilities.compareObjects(old, c.old)
153: && Utilities.compareObjects(nue, c.nue);
154: }
155:
156: public int hashCode() {
157: return source.hashCode()
158: ^ (prop == null ? 0 : prop.hashCode());
159: }
160:
161: public String toString() {
162: return "Change[" + source + ":" + prop + ";" + old + "->"
163: + nue + "]"; // NOI18N
164: }
165: }
166:
167: }
|