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.api.project;
043:
044: import java.beans.PropertyChangeListener;
045: import javax.swing.Icon;
046: import org.openide.filesystems.FileObject;
047:
048: // XXX should be PROP_* constants for rootFolder, name, displayName, icon
049:
050: /**
051: * Representation of one area of sources.
052: * @author Jesse Glick
053: * @see Sources
054: */
055: public interface SourceGroup {
056:
057: /**
058: * Pseudo-property used to indicate changes in containership of some subfiles.
059: * (The old and new value should be left null.)
060: */
061: String PROP_CONTAINERSHIP = "containership"; // NOI18N
062:
063: /**
064: * Get the folder forming the root of this group of sources.
065: * @return the root folder (must be a folder, not a file)
066: */
067: FileObject getRootFolder();
068:
069: /**
070: * Get a code name suitable for internal identification of this source group.
071: * Should be unique among the source groups of a given type
072: * contained in a single {@link Sources} object.
073: * @return a code name
074: */
075: String getName();
076:
077: /**
078: * Get a display name suitable for presentation to a user.
079: * Should preferably be unique among the source groups of a given type
080: * contained in a single {@link Sources} object.
081: * @return a display name
082: */
083: String getDisplayName();
084:
085: /**
086: * Get an icon for presentation to a user.
087: * @param opened if true, may select an alternative "open" variant
088: * @return an icon, or null if no specific icon is needed
089: */
090: Icon getIcon(boolean opened);
091:
092: /**
093: * Check whether the given file is contained in this group.
094: * <p>
095: * A constraint is that the root folder must be contained and
096: * if any file or folder (other than the root folder) is contained then
097: * its parent must be as well. Therefore, while the return value is precise
098: * for files, and a false return value means what it sounds like for folders,
099: * a true return value for folders may mean that just parts of the folder are
100: * contained in the group.
101: * </p>
102: * @param file a file or folder; must be a descendant of the root folder
103: * @return true if the group contains that file, false if it is to be excluded
104: * @throws IllegalArgumentException if a file is passed which is not inside the root
105: */
106: boolean contains(FileObject file) throws IllegalArgumentException;
107:
108: /**
109: * Add a listener to changes in aspects of the source group.
110: * The property names used may be normal JavaBean names
111: * (<code>rootFolder</code>, <code>name</code>, <code>displayName</code>,
112: * <code>icon</code>) or {@link #PROP_CONTAINERSHIP}.
113: * @param listener a listener to add
114: */
115: void addPropertyChangeListener(PropertyChangeListener listener);
116:
117: /**
118: * Remove a listener to changes in aspects of the source group.
119: * @param listener a listener to remove
120: */
121: void removePropertyChangeListener(PropertyChangeListener listener);
122:
123: }
|