KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > spi > ejbjar > EjbJarImplementation


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.modules.j2ee.spi.ejbjar;
21
22 import org.netbeans.modules.j2ee.metadata.MetadataUnit;
23 import org.openide.filesystems.FileObject;
24
25 /**
26  * SPI interface for {@link org.netbeans.modules.j2ee.api.ejbjar.EjbJar}.
27  * @see EjbJarFactory
28  */
29 public interface EjbJarImplementation {
30
31     /** J2EE platform version - one of the constants
32      * defined in {@link org.netbeans.modules.j2ee.api.common.EjbProjectConstants}.
33      * @return J2EE platform version
34      */
35     String JavaDoc getJ2eePlatformVersion ();
36     /**
37      * META-INF folder for the ejb module.
38      *
39      * @return the {@link FileObject}; might be <code>null</code>
40      */
41     FileObject getMetaInf ();
42
43     /**
44      * Deployment descriptor (ejb-jar.xml file) of the ejb module.
45      *
46      * @return the {@link FileObject}; might be <code>null</code>
47      */
48     FileObject getDeploymentDescriptor ();
49
50     /** Source roots associated with the EJB module.
51      * <div class="nonnormative">
52      * Note that not all the java source roots in the project (e.g. in a freeform project)
53      * belong to the EJB module.
54      * </div>
55      */
56     FileObject[] getJavaSources();
57     
58     /**
59      * Coupling of deployment desrciptor and classpath containing annotated classes
60      * describing metadata of the EJB module
61      *
62      * @return non-null value
63      */
64     MetadataUnit getMetadataUnit();
65     
66 }
67
Popular Tags