org.jboss.forge.addon.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
org.jboss.forge.furnace.spi.ListenerRegistration<ProjectListener>	addProjectListener(ProjectListener listener) Register a listener for project events
boolean	containsProject(FileResource<?> target) Returns true if a Project exists in the ancestry of the given FileResource.
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(FileResource<?> target) Locate a Project in the ancestry of the given FileResource.
Project	findProject(FileResource<?> target, org.jboss.forge.furnace.util.Predicate<Project> filter) Locate a Project in the ancestry of the given FileResource.

Method Detail

findProject

Project findProject(FileResource<?> target)

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

findProject

Project findProject(FileResource<?> target,
                  org.jboss.forge.furnace.util.Predicate<Project> filter)

Locate a Project in the ancestry of the given FileResource. 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.

containsProject

boolean containsProject(FileResource<?> target)

Returns true if a Project exists in the ancestry of the given FileResource. false if no Project could be located

createTempProject

Project createTempProject()

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

addProjectListener

org.jboss.forge.furnace.spi.ListenerRegistration<ProjectListener> addProjectListener(ProjectListener listener)

Register a listener for project events