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.spi.project;
43:
44: import java.util.Set;
45: import javax.swing.event.ChangeListener;
46: import org.netbeans.api.project.Project;
47:
48: /**
49: * Optional ability of projects which may have a list of "subprojects".
50: * The exact interpretation of this term is at the discretion of the project,
51: * but typically subprojects would be "built" as part of this project or somehow
52: * used in it as dependencies; or they may just be contained or agglomerated in
53: * it somehow.
54: * @see Project#getLookup
55: * @see <a href="@org-netbeans-modules-project-ant@/org/netbeans/spi/project/support/ant/ReferenceHelper.html#createSubprojectProvider()"><code>ReferenceHelper.createSubprojectProvider</code></a>
56: * @author Jesse Glick
57: */
58: public interface SubprojectProvider {
59:
60: /**
61: * Get a set of projects which this project can be considered to depend upon somehow.
62: * This information is likely to be used only for UI purposes.
63: * Only direct subprojects need be listed, not all recursive subprojects.
64: * There may be no direct or indirect cycles in the project dependency graph
65: * but it may be a DAG, i.e. two projects may both depend on the same subproject.
66: * @return an immutable and unchanging set of {@link Project}s
67: * @see org.netbeans.api.project.ProjectUtils#hasSubprojectCycles
68: */
69: Set<? extends Project> getSubprojects();
70:
71: /**
72: * Add a listener to changes in the set of subprojects.
73: * @param listener a listener to add
74: */
75: void addChangeListener(ChangeListener listener);
76:
77: /**
78: * Remove a listener to changes in the set of subprojects.
79: * @param listener a listener to remove
80: */
81: void removeChangeListener(ChangeListener listener);
82:
83: }
|