LookupMerger


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   * Allows project lookup to merge instances of known classes and replace them
26   * with single instance. To be used in conjunction with the {@link org.netbeans.spi.project.LookupProvider}
27   * and {@link org.netbeans.spi.project.support.LookupProviderSupport}
28   * The interface is to be implemented by the project owner which decides which contracts make sense to have merged and
29   * how they are to be merged.
30   * The 3rd party {@link org.netbeans.spi.project.LookupProvider} implementors provide instances of mergeableClass.
31   * {@link org.netbeans.spi.project.support.LookupProviderSupport#createCompositeLookup} handles the hiding of individual mergeable instances 
32   * and exposing the merged instance created by the <code>LookupMerger</code>.
33   * @param T the type of object being merged (see {@link org.netbeans.api.project.Project#getLookup} for examples)
34   * @author mkleint
35   * @since org.netbeans.modules.projectapi 1.12
36   */
37  public interface LookupMerger<T> {
38      
39      /**
40       * Returns a class which is merged by this implementation of LookupMerger
41       * @return Class instance
42       */
43      Class  <T> getMergeableClass();
44      
45      /**
46       * Merge instances of the given class in the given lookup and return merged 
47       * object which substitutes them.
48       * @param lookup lookup with the instances
49       * @return object to be used instead of instances in the lookup
50       */
51      T merge(Lookup lookup);
52  
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags