2
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
6
* The contents of this file are subject to the terms of either the GNU
7
* General Public License Version 2 only ("GPL") or the Common
8
* Development and Distribution License("CDDL") (collectively, the
9
* "License"). You may not use this file except in compliance with the
10
* License. You can obtain a copy of the License at
11
* http://www.netbeans.org/cddl-gplv2.html
12
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13
* specific language governing permissions and limitations under the
14
* License. When distributing the software, include this License Header
15
* Notice in each file and include the License file at
16
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17
* particular file as subject to the "Classpath" exception as provided
18
* by Sun in the GPL Version 2 section of the License file that
19
* accompanied this code. If applicable, add the following below the
20
* License Header, with the fields enclosed by brackets [] replaced by
21
* your own identifying information:
22
* "Portions Copyrighted [year] [name of copyright owner]"
26
* The Original Software is NetBeans. The Initial Developer of the Original
27
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28
* Microsystems, Inc. All Rights Reserved.
30
* If you wish your version of this file to be governed by only the CDDL
31
* or only the GPL Version 2, indicate your decision by adding
32
* "[Contributor] elects to include this software in this distribution
33
* under the [CDDL or GPL Version 2] license." If you do not indicate a
34
* single choice of license, a recipient has the option to distribute
35
* your version of this file under either the CDDL, the GPL Version 2 or
36
* to extend the choice of license to its licensees as provided above.
37
* However, if you add GPL Version 2 code and therefore, elected the GPL
38
* Version 2 license, then the option applies only if the new code is
39
* made subject to such option by the copyright holder.
42
package org.netbeans.spi.project;
44
import java.io.IOException;
45
import org.netbeans.api.project.Project;
46
import org.openide.filesystems.FileObject;
49
* Create in-memory projects from disk directories.
50
* Instances should be registered into default lookup.
53
public interface ProjectFactory {
56
* Test whether a given directory probably refers to a project recognized by this factory
57
* without actually trying to create it.
58
* <p>Should be as fast as possible as it might be called sequentially on a
59
* lot of directories.</p>
60
* <p>Need not be definite; it is permitted to return null or throw an exception
61
* from {@link #loadProject} even when returning <code>true</code> from this
62
* method, in case the directory looked like a project directory but in fact
63
* had something wrong with it.</p>
64
* <p>Will be called inside read access.</p>
65
* @param projectDirectory a directory which might refer to a project
66
* @return true if this factory recognizes it
68
boolean isProject(FileObject projectDirectory);
71
* Create a project that resides on disk.
72
* If this factory does not
73
* in fact recognize the directory, it should just return null.
74
* <p>Will be called inside read access.
75
* <p>Do not do your own caching! The project manager caches projects for you, properly.
76
* <p>Do not attempt to recognize subdirectories of your project directory (just return null),
77
* unless they are distinct nested projects.
78
* @param projectDirectory some directory on disk
79
* @param state a callback permitting the project to indicate when it is modified
80
* @return a matching project implementation, or null if this factory does not recognize it
82
Project loadProject(FileObject projectDirectory, ProjectState state) throws IOException;
85
* Save a project to disk.
86
* <p>Will be called inside write access.
87
* @param project a project created with this factory's {@link #loadProject} method
88
* @throws IOException if there is a problem saving
89
* @throws ClassCastException if this factory did not create this project
91
void saveProject(Project project) throws IOException, ClassCastException;