KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > j2ee > persistence > spi > PersistenceScopeImplementation


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.persistence.spi;
21
22 import org.netbeans.api.java.classpath.ClassPath;
23 import org.openide.filesystems.FileObject;
24
25 /**
26  * The SPI for {@link org.netbeans.modules.j2ee.persistence.api.PersistenceScope}.
27  *
28  * @author Andrei Badea
29  *
30  * @see org.netbeans.modules.j2ee.persistence.api.PersistenceScope
31  * @see PersistenceScopeFactory
32  */
33 public interface PersistenceScopeImplementation {
34
35     /**
36      * Returns the persistence.xml file of this persistence scope.
37      *
38      * @return the persistence.xml file or null if it the persistence.xml file does
39      * not exist.
40      */
41     FileObject getPersistenceXml();
42
43     /**
44      * Provides the classpath of this persistence scope, which covers the sources
45      * of the entity classes referenced by the persistence.xml file, as well
46      * as the referenced JAR files.
47      *
48      * @return the persistence scope classpath; never null.
49      */
50     ClassPath getClassPath();
51 }
52
Popular Tags