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 threaddemo.data;
043:
044: import java.io.IOException;
045: import javax.swing.event.ChangeListener;
046: import org.w3c.dom.Document;
047: import threaddemo.locking.RWLock;
048:
049: /**
050: * Cookie for an object with a DOM tree.
051: * @author Jesse Glick
052: */
053: public interface DomProvider {
054:
055: /**
056: * Prepare for parsing. If the DOM tree is not already
057: * available, parsing will be initiated. To receive notification
058: * of completion, attach a listener.
059: */
060: void start();
061:
062: /**
063: * Get the parsed document (blocking as needed).
064: * @throws IOException if it cannot be read or parsed
065: */
066: Document getDocument() throws IOException;
067:
068: /**
069: * Set the parsed document.
070: * @throws IOException if it cannot be written
071: */
072: void setDocument(Document d) throws IOException;
073:
074: /**
075: * True if the parse is finished and OK (does not block except for lock).
076: */
077: boolean isReady();
078:
079: /**
080: * Listen for changes in status.
081: */
082: void addChangeListener(ChangeListener l);
083:
084: /**
085: * Stop listening for changes in status.
086: */
087: void removeChangeListener(ChangeListener l);
088:
089: /**
090: * Lock on which to lock while doing things.
091: */
092: RWLock lock();
093:
094: /**
095: * Do an isolated block of operations to the document (must be in the write lock).
096: * During this block you may not call any other methods of this interface which
097: * require the lock (in read or write mode), or this method itself; you may
098: * only adjust the document using DOM mutations.
099: * Changes will be fired, and any underlying storage recreated, only when the
100: * block is finished (possibly with an error). Does not roll back partial blocks.
101: */
102: void isolatingChange(Runnable r);
103:
104: }
|