/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.netbeans.api.project;
import javax.swing.event.ChangeListener;
/**
* Optional interface for a project to enumerate folders containing sources
* of various kinds.
* <strong>Use {@link ProjectUtils#getSources} as a client.</strong>
* Use {@link Project#getLookup} as a provider.
* <p class="nonnormative">
* May be used by the New File wizard, Find in Files, to-do task scanning,
* the Files tab, etc.
* </p>
* @see <a href="@org-netbeans-modules-project-ant@/org/netbeans/spi/project/support/ant/SourcesHelper.html"><code>SourcesHelper</code></a>
* @author Jesse Glick
*/
public interface Sources {
/**
* Generic source folders containing any source files at all.
* Generally should be a superset of all other kinds of source folders.
* Usually the project directory is the only such folder listed.
*/
String TYPE_GENERIC = "generic"; // NOI18N
/**
* Find all root source folders matching a given type.
* <p>For a given type, the returned source folders must not overlap, i.e.
* there may be no duplicates and no folder may be a descendant of another.
* <p>In the case of {@link #TYPE_GENERIC} source folders, the project must
* contain at least one such folder (a nonempty array must be returned), and
* the {@link Project#getProjectDirectory project directory} must either be
* one of the returned folders, or a descendant of one of the returned folders.
* @param type a kind of folder, e.g. {@link #TYPE_GENERIC} or
* <a href="@org-netbeans-modules-java-project@/org/netbeans/api/java/project/JavaProjectConstants.html#SOURCES_TYPE_JAVA"><code>JavaProjectConstants.SOURCES_TYPE_JAVA</code></a>
* @return a list of top-level source folders of that kind (may be empty but not null)
*/
SourceGroup[] getSourceGroups(String type);
/**
* Add a listener to changes in the source groups.
* Any change in the result of {@link #getSourceGroups} should
* cause a change event to be fired.
* @param listener a listener to add
*/
public void addChangeListener(ChangeListener listener);
/**
* Remove a listener to changes in the source groups.
* @param listener a listener to remove
*/
public void removeChangeListener(ChangeListener listener);
}
|