org.jboss.forge.addon.facets

Interface Facet<FACETEDTYPE extends Faceted<?>>

Type Parameters:

FACETED - The Faceted type to which this Facet may attach.

All Known Subinterfaces:

CDIFacet<T>, CDIFacet_1_0, CDIFacet_1_1, ConfigurationFacet, DependencyFacet, EJBFacet, EJBFacet_3_1, EJBFacet_3_2, EnterpriseResourcesFacet, FacesFacet<DESCRIPTOR>, FacesFacet_2_0, FacesFacet_2_1, FacesFacet_2_2, GitAPIFacet, GitFacet, GitIgnoreFacet, HintsFacet, JavaCompilerFacet, JavaEEFacet, JavaSourceFacet, JAXWSFacet, JMSFacet, JPAFacet<DESCRIPTOR>, JPAFacet_2_0, JPAFacet_2_1, JSTLFacet, JTAFacet, JTAFacet_1_1, JTAFacet_1_2, MavenFacet, MavenPluginFacet, MetadataFacet, ModuleFacet, MutableFacet<FACETEDTYPE>, PackagingFacet, PersistenceMetaModelFacet, ProjectFacet, ProvidedProjectFacet, ResourceFacet, ResourcesFacet, RestFacet, RestFacet_1_1, RestFacet_2_0, ServletFacet<DESCRIPTOR>, ServletFacet_2_5, ServletFacet_3_0, ServletFacet_3_1, TemplateFacet, ValidationFacet, WebResourcesFacet, WebSocketFacet

All Known Implementing Classes:

AbstractFacet, AddonAddonFacet, AddonAPIFacet, AddonClassifierFacet, AddonImplFacet, AddonParentFacet, AddonSPIFacet, AddonTestFacet, DefaultFurnaceContainerAPIFacet, DefaultFurnaceContainerFacet, ForgeBOMFacet, FurnaceAPIFacet, FurnacePluginFacet, FurnaceVersionFacet

public interface Facet<FACETEDTYPE extends Faceted<?>>

A Facet is an access point to common functionality, file manipulations, descriptors that extend a Faceted instance. When implementing this interface, consider extending AbstractFacet for convenience.

Author:

Lincoln Baxter, III, Ken Finnigan

See Also:

AbstractFacet}

Method Summary

Methods

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

Method Detail

getFaceted

FACETEDTYPE getFaceted()

Return the Faceted instance on which this Facet operates. Each Facet belongs to a Faceted object (an object that has facets). Once this Facet has been installed, the Faceted instance cannot be changed.

Typically, the Faceted instance is provided at Facet creation time, when the facet is constructed via the FacetFactory.

install

boolean install()

Perform necessary setup for this Facet to be considered installed in the given Faceted instance. This method should NOT register the facet; facet registration is handled by the Faceted instance 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 Faceted instance, false if otherwise.

uninstall

boolean uninstall()

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