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.modules.web.spi.webmodule;
43:
44: import org.netbeans.modules.web.api.webmodule.WebModule;
45: import org.openide.filesystems.FileObject;
46:
47: /**
48: * Provider interface for web modules.
49: *
50: * <p>The <code>org.netbeans.api.web.webmodule</code> module registers an
51: * implementation of this interface to global lookup which looks for the
52: * project which owns a file (if any) and checks its lookup for this interface,
53: * and if it finds an instance, delegates to it. Therefore it is not normally
54: * necessary for a project type provider to register its own instance just to
55: * define the web module for files it owns, assuming it uses projects for
56: * implementation of the web module.</p>
57: *
58: * <p>If needed a new implementation of this interface can be registered in
59: * global lookup.</p>
60: *
61: * @see WebModule#getWebModule
62: *
63: * @author Pavel Buzek
64: */
65: public interface WebModuleProvider {
66:
67: /**
68: * Find the web module containing a given file.
69: *
70: * @param file a file; never null.
71: * @return a web module, or null if this provider could not find a web module
72: * containing this file.
73: *
74: * @see WebModuleFactory
75: */
76: WebModule findWebModule(FileObject file);
77: }
|