ProjectFactory (NetBeans Project API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.project
Interface ProjectFactory

public interface ProjectFactory

Create in-memory projects from disk directories. Instances should be registered into default lookup.

Method Summary

boolean isProject(FileObject projectDirectory)
          Test whether a given directory probably refers to a project recognized by this factory without actually trying to create it.

Project loadProject(FileObject projectDirectory, ProjectState state)
          Create a project that resides on disk.

void saveProject(Project project)
          Save a project to disk.

Method Detail

isProject

public boolean isProject(FileObject projectDirectory)

Test whether a given directory probably refers to a project recognized by this factory without actually trying to create it.

Should be as fast as possible as it might be called sequentially on a lot of directories.

Need not be definite; it is permitted to return null or throw an exception from loadProject(org.openide.filesystems.FileObject, org.netbeans.spi.project.ProjectState) even when returning true from this method, in case the directory looked like a project directory but in fact had something wrong with it.

Will be called inside read access.

Parameters:: projectDirectory - a directory which might refer to a project
Returns:: true if this factory recognizes it

loadProject

public Project loadProject(FileObject projectDirectory,
                           ProjectState state)
                    throws IOException

Create a project that resides on disk. If this factory does not in fact recognize the directory, it should just return null.