PersistenceLocationProvider


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 java.io.IOException  ;
23  import org.openide.filesystems.FileObject;
24  
25  /**
26   * This interface should be implemented in a context which supports
27   * Java Persistence API, whether or not is contains a persistence.xml file. It
28   * contains methods for creating/retrieving the default location for persistence.xml
29   * files. For example it can be implemented by a project and can be used by 
30   * a client which wants to create a persistence scope in that project.
31   *
32   * @author Andrei Badea
33   */
34  public interface PersistenceLocationProvider {
35  
36      /**
37       * Returns the default location for persistence.xml and related files.
38       *
39       * @return the default location or null if it does not exist.
40       */
41      FileObject getLocation();
42  
43      /**
44       * Creates (if it does not exist) and returns the default location for
45       * persistence.xml and related files.
46       *
47       * @return the default location; never null.
48       *
49       * @throws IOException if an error occured while creating the location
50       * of persistence.xml
51       */
52      FileObject createLocation() throws IOException  ;
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags