KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > web > spi > webmodule > WebModuleImplementation


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 package org.netbeans.modules.web.spi.webmodule;
20
21 import org.openide.filesystems.FileObject;
22
23 /**
24  * SPI interface for {@link org.netbeans.modules.web.api.webmodule.WebModule}.
25  * @see WebModuleFactory
26  */
27 public interface WebModuleImplementation {
28
29     /** Folder that contains sources of the static documents for
30      * the web module (html, JSPs, etc.).
31      */
32     FileObject getDocumentBase ();
33
34     /** Context path of the web module.
35      */
36     String JavaDoc getContextPath ();
37
38     /** J2EE platform version - one of the constants
39      * {@link org.netbeans.modules.web.api.webmodule.WebModule#J2EE_13_LEVEL},
40      * {@link org.netbeans.modules.web.api.webmodule.WebModule#J2EE_14_LEVEL}.
41      * @return J2EE platform version
42      */
43     String JavaDoc getJ2eePlatformVersion ();
44     
45     /**
46      * WEB-INF folder for the web module.
47      * <div class="nonnormative">
48      * The WEB-INF folder would typically be a child of the folder returned
49      * by {@link #getDocumentBase} but does not need to be.
50      * </div>
51      *
52      * @return the {@link FileObject}; might be <code>null</code>
53      */
54     FileObject getWebInf ();
55
56     /**
57      * Deployment descriptor (web.xml file) of the web module.
58      * <div class="nonnormative">
59      * The web.xml file would typically be a child of the folder returned
60      * by {@link #getWebInf} but does not need to be.
61      * </div>
62      *
63      * @return the {@link FileObject}; might be <code>null</code>
64      */
65     FileObject getDeploymentDescriptor ();
66     
67     /** Source roots associated with the web module.
68      * <div class="nonnormative">
69      * Note that not all the java source roots in the project (e.g. in a freeform project)
70      * belong to the web module.
71      * </div>
72      */
73     FileObject[] getJavaSources();
74     
75 }
76
Popular Tags