KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > metadata > MetadataUnit


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.metadata;
21
22 import org.netbeans.api.java.classpath.ClassPath;
23 import org.openide.filesystems.FileObject;
24
25 /**
26  * This interface is logical unit for metadata providing.
27  * Metadata can be specified in XLM descriptor (configuration file),
28  * or annotations defined in Java classes. This unit is used for coupling
29  * XML-based descriptor with Java classes and it is basic key to pass to
30  * DD API providers (instead of XML FileObject used in the past).
31  *
32  * @author Martin Adamek
33  */
34 public interface MetadataUnit {
35     
36     /**
37      * Provides unit's XML descriptor
38      *
39      * @return descriptor FileObject or null if not available
40      */
41     FileObject getDeploymentDescriptor();
42
43     /**
44      * Provides unit's classpath, which covers sources and libraries logically
45      * coupled with XML descriptor. Note, that if XML doesn't exist, this
46      * classpath is only place where metadata comes from and it describes where
47      * can be annotated classes related to this unit found.
48      *
49      * @return classpath of the unit
50      */
51     ClassPath getClassPath();
52
53 }
54
Popular Tags