KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > project > ui > support > NodeFactory


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.spi.project.ui.support;
21
22 import org.netbeans.api.project.Project;
23
24 /**
25  * Factory interface for distributed creation of project node's children. Implementation
26  * instances are assumed to be registered in layers at a location specific for the particular
27  * project type. Project types wanting to make use of NodeFactory can use the
28  * {@link org.netbeans.spi.project.ui.support.NodeFactorySupport#createCompositeChildren}
29  * method to create the Project nodes's children.
30  *
31 <pre>
32 public class FooBarLogicalViewProvider implements LogicalViewProvider {
33     public Node createLogicalView() {
34         return new FooBarRootNode(NodeFactorySupport.createCompositeChildren("Projects/org-foo-bar-project/Nodes");
35     }
36   
37 }
38 </pre>
39  * @author RichUnger
40  * @since org.netbeans.modules.projectuiapi/1 1.18
41  */
42 public interface NodeFactory {
43     
44     /**
45      * Create a list of children nodes for the given project. If the list is to be static,
46      * use the {@link org.netbeans.spi.project.ui.support.NodeFactorySupport#fixedNodeList}
47      * @return never return null, if the project is not relevant to the NodeFactory,
48      * use {@link org.netbeans.spi.project.ui.support.NodeFactorySupport#fixedNodeList} empty value.
49      */
50     NodeList<?> createNodes(Project p);
51     
52 // Node findPath(Project p, Node root, Object target);
53
54 }
55
Popular Tags