org.jboss.forge.projects

Interface ProjectFactory

@Exported
public interface ProjectFactory

Used to create new or obtain references to existing Project instances.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
ListenerRegistration<ProjectListener>	addProjectListener(ProjectListener listener) Register a listener for project events
Project	createProject(DirectoryResource projectDir) Create a Project in the specified DirectoryResource.
Project	createProject(DirectoryResource targetDir, Iterable<Class<? extends ProjectFacet>> facetTypes) Create a Project with the given ProjectFacet types in the specified DirectoryResource.
Project	createTempProject() Create a Project in a temporary location.
Project	findProject(DirectoryResource target) Locate a Project in the ancestry of the given DirectoryResource.
Project	findProject(DirectoryResource target, Predicate<Project> filter) Locate a Project in the ancestry of the given DirectoryResource.

Method Detail

findProject

Project findProject(DirectoryResource target)

Locate a Project in the ancestry of the given DirectoryResource. Return null if no Project could be located.

findProject

Project findProject(DirectoryResource target,
                  Predicate<Project> filter)

Locate a Project in the ancestry of the given DirectoryResource. Filter results using the given Predicate. Return null if no Project could be located.

createProject

Project createProject(DirectoryResource projectDir)

Create a Project in the specified DirectoryResource.

createProject

Project createProject(DirectoryResource targetDir,
                    Iterable<Class<? extends ProjectFacet>> facetTypes)

Create a Project with the given ProjectFacet types in the specified DirectoryResource.

createTempProject

Project createTempProject()

Create a Project in a temporary location. This method is useful for testing purposes.

addProjectListener

ListenerRegistration<ProjectListener> addProjectListener(ProjectListener listener)

Register a listener for project events