org.jboss.forge.project

Interface Facet

All Known Subinterfaces:

DependencyFacet, JavaExecutionFacet, JavaSourceFacet, MetadataFacet, PackagingFacet, ResourceFacet, WebResourceFacet

All Known Implementing Classes:

BaseFacet, ConfigurationFacet

public interface Facet

Represents a standardized piece of a project on which certain Plugin types may rely for a set of domain-specific operations. A Facet is an access point to common functionality, file manipulations, descriptors that extend a Project instance. When implementing this interface, consider extending BaseFacet for convenience.

Facets may be annotated with any of the following constraints in order to ensure proper dependencies are satisfied at runtime: RequiresFacet, RequiresPackagingType

Author:

Lincoln Baxter, III

See Also:

BaseFacet}

Method Summary

Methods

Modifier and Type	Method and Description
Project	getProject() Return the Project instance on which this Facet operates.
boolean	install() Perform necessary setup for this Facet to be considered installed in the given Project.
boolean	isInstalled() Return true if the Facet is available for the given Project, false if otherwise.
void	setProject(Project project) Initialize this Facet for operation on the given Project.
boolean	uninstall() Remove this Facet from its Project, and perform any necessary cleanup.

Method Detail

getProject

Project getProject()

Return the Project instance on which this Facet operates.

setProject

void setProject(Project project)

Initialize this Facet for operation on the given Project. This method is responsible for ensuring that the Facet instance is ready for use, and must be called before any other methods.

install

boolean install()

Perform necessary setup for this Facet to be considered installed in the given Project. This method should NOT register the facet; facet registration is handled by the project if installation is successful.

Returns:

true if installation was successful, false if not.

isInstalled

boolean isInstalled()

Return true if the Facet is available for the given Project, false if otherwise.

uninstall

boolean uninstall()

Remove this Facet from its Project, and perform any necessary cleanup.