org.jboss.forge.facets

Interface Facet<FACETED extends Faceted<?>>

Type Parameters:

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

All Known Subinterfaces:

MutableOrigin<FACETED>

All Known Implementing Classes:

AbstractFacet

@Exported
public interface Facet<FACETED 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
FACETED	getOrigin() 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

getOrigin

FACETED getOrigin()

Return the Faceted instance on which this Facet operates.

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.