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 org.openide.util.Lookup;
45:
46: /**
47: * Allows project lookup to merge instances of known classes and replace them
48: * with single instance. To be used in conjunction with the {@link org.netbeans.spi.project.LookupProvider}
49: * and {@link org.netbeans.spi.project.support.LookupProviderSupport}
50: * The interface is to be implemented by the project owner which decides which contracts make sense to have merged and
51: * how they are to be merged.
52: * The 3rd party {@link org.netbeans.spi.project.LookupProvider} implementors provide instances of mergeableClass.
53: * {@link org.netbeans.spi.project.support.LookupProviderSupport#createCompositeLookup} handles the hiding of individual mergeable instances
54: * and exposing the merged instance created by the <code>LookupMerger</code>.
55: * @param T the type of object being merged (see {@link org.netbeans.api.project.Project#getLookup} for examples)
56: * @author mkleint
57: * @since org.netbeans.modules.projectapi 1.12
58: */
59: public interface LookupMerger<T> {
60:
61: /**
62: * Returns a class which is merged by this implementation of LookupMerger
63: * @return Class instance
64: */
65: Class<T> getMergeableClass();
66:
67: /**
68: * Merge instances of the given class in the given lookup and return merged
69: * object which substitutes them.
70: * @param lookup lookup with the instances
71: * @return object to be used instead of instances in the lookup
72: */
73: T merge(Lookup lookup);
74:
75: }
|