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:
42: package org.netbeans.api.project;
43:
44: import javax.swing.event.ChangeListener;
45:
46: /**
47: * Optional interface for a project to enumerate folders containing sources
48: * of various kinds.
49: * <strong>Use {@link ProjectUtils#getSources} as a client.</strong>
50: * Use {@link Project#getLookup} as a provider.
51: * <p class="nonnormative">
52: * May be used by the New File wizard, Find in Files, to-do task scanning,
53: * the Files tab, etc.
54: * </p>
55: * @see <a href="@org-netbeans-modules-project-ant@/org/netbeans/spi/project/support/ant/SourcesHelper.html"><code>SourcesHelper</code></a>
56: * @author Jesse Glick
57: */
58: public interface Sources {
59:
60: /**
61: * Generic source folders containing any source files at all.
62: * Generally should be a superset of all other kinds of source folders.
63: * Usually the project directory is the only such folder listed.
64: */
65: String TYPE_GENERIC = "generic"; // NOI18N
66:
67: /**
68: * Find all root source folders matching a given type.
69: * <p>For a given type, the returned source folders must not overlap, i.e.
70: * there may be no duplicates and no folder may be a descendant of another.
71: * <p>In the case of {@link #TYPE_GENERIC} source folders, the project must
72: * contain at least one such folder (a nonempty array must be returned), and
73: * the {@link Project#getProjectDirectory project directory} must either be
74: * one of the returned folders, or a descendant of one of the returned folders.
75: * @param type a kind of folder, e.g. {@link #TYPE_GENERIC} or
76: * <a href="@org-netbeans-modules-java-project@/org/netbeans/api/java/project/JavaProjectConstants.html#SOURCES_TYPE_JAVA"><code>JavaProjectConstants.SOURCES_TYPE_JAVA</code></a>
77: * @return a list of top-level source folders of that kind (may be empty but not null)
78: */
79: SourceGroup[] getSourceGroups(String type);
80:
81: /**
82: * Add a listener to changes in the source groups.
83: * Any change in the result of {@link #getSourceGroups} should
84: * cause a change event to be fired.
85: * @param listener a listener to add
86: */
87: public void addChangeListener(ChangeListener listener);
88:
89: /**
90: * Remove a listener to changes in the source groups.
91: * @param listener a listener to remove
92: */
93: public void removeChangeListener(ChangeListener listener);
94:
95: }
|