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.model;
043:
044: import java.io.IOException;
045: import java.io.InputStream;
046: import java.io.OutputStream;
047: import java.util.List;
048: import threaddemo.locking.RWLock;
049:
050: /**
051: * Really, a file.
052: * Mutator methods (rename, delete, create*Phadhail) cannot be called
053: * from within a listener callback, or generally without read access.
054: * You *can* add/remove listeners from within a listener callback however,
055: * or in fact at any other time (without even a lock).
056: * Methods from java.lang.Object (toString, hashCode, equals) can be called at any time.
057: * @author Jesse Glick
058: */
059: public interface Phadhail {
060:
061: /** will be simple file name */
062: String getName();
063:
064: /** will be full path */
065: String getPath();
066:
067: /** rename (within parent) */
068: void rename(String nue) throws IOException;
069:
070: /** will be true if a directory */
071: boolean hasChildren();
072:
073: /**
074: * Get a list of child files.
075: * caller cannot mutate list, and it might not be thread-safe
076: * implementor cannot change list after creation (i.e. size & identity of elements)
077: * it is expected that once the list is obtained, asking for elements is fast and nonblocking
078: * (and then the read lock is not required)
079: */
080: List<Phadhail> getChildren();
081:
082: /** delete this phadhail (must not have children) */
083: void delete() throws IOException;
084:
085: /** make a new phadhail without children */
086: Phadhail createLeafPhadhail(String name) throws IOException;
087:
088: /** make a new phadhail with children */
089: Phadhail createContainerPhadhail(String name) throws IOException;
090:
091: /** read */
092: InputStream getInputStream() throws IOException;
093:
094: /** write (note: in this simple model, no locks here) */
095: OutputStream getOutputStream() throws IOException;
096:
097: /** add a listener */
098: void addPhadhailListener(PhadhailListener l);
099:
100: /** remove a listener */
101: void removePhadhailListener(PhadhailListener l);
102:
103: /**
104: * Get a lock appropriate for locking operations from another thread.
105: * Should be a single lock for a whole tree of phadhails.
106: * Model methods should automatically acquire the relevant lock for you;
107: * the view need not bother, unless it needs to do an atomic operation.
108: */
109: RWLock lock();
110:
111: }
|