KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > spi > project > LookupProvider


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;
21
22 import org.openide.util.Lookup;
23
24 /**
25  * interface for inclusion of 3rd party content in project's lookup. Typically, if the
26  * project type allows composition of lookup from multiple sources, it will make a layer
27  * location public where 3rd parties will register implementations of this interface.
28  * @author mkleint
29  * @since org.netbeans.modules.projectapi 1.12
30  */
31 public interface LookupProvider {
32     
33     /**
34      * implementations will be asked to create their additional project lookup based on the baseContext
35      * passed as parameter. The content of baseLookup is undefined on this level, is a contract
36      * of the actual project type. Can be complete lookup of the project type, a portion of it or
37      * something completely different that won't appear in the final project lookup.
38      * Each implementation is only asked once for it's lookup for a given project instance at the time
39      * when project's lookup is being created.
40      * @param baseContext implementation shall decide what to return for a given project instance based on context
41      * passed in.
42      * @return a {@link org.openide.util.Lookup} instance that is to be added to the project's lookup, never null.
43      */
44     Lookup createAdditionalLookup(Lookup baseContext);
45 }
46
Popular Tags