org.jboss.forge.addon.facets

Class AbstractFacet<FACETEDTYPE extends Faceted<?>>

java.lang.Object

org.jboss.forge.addon.facets.AbstractFacet<FACETEDTYPE>

Type Parameters:

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

All Implemented Interfaces:

Facet<FACETEDTYPE>, MutableFacet<FACETEDTYPE>

Direct Known Subclasses:

AbstractProjectFacet, AddonAddonFacet, AddonAPIFacet, AddonClassifierFacet, AddonImplFacet, AddonParentFacet, AddonSPIFacet, AddonTestFacet, DefaultFurnaceContainerAPIFacet, DefaultFurnaceContainerFacet, ForgeBOMFacet, ForgeVersionFacet, FurnaceAPIFacet, FurnaceBOMFacet, FurnacePluginFacet, FurnaceVersionFacet

public abstract class AbstractFacet<FACETEDTYPE extends Faceted<?>>
extends Object
implements MutableFacet<FACETEDTYPE>

A base convenience Facet abstract class.

Author:

Lincoln Baxter, III, Ken Finnigan

Field Summary

Fields

Modifier and Type	Field and Description
protected FACETEDTYPE	origin

Constructor Summary

Constructors

Constructor and Description
AbstractFacet()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
FACETEDTYPE	getFaceted() Return the Faceted instance on which this Facet operates.
int	hashCode() Facet instances are the same if they are registered to the same project.
void	setFaceted(FACETEDTYPE origin) Set the origin on which this Facet will operate.
boolean	uninstall() Remove this Facet from its Faceted instance, and perform any necessary cleanup.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.forge.addon.facets.Facet

install, isInstalled

Field Detail

origin

protected FACETEDTYPE extends Faceted<?> origin

Constructor Detail

AbstractFacet

public AbstractFacet()

Method Detail

getFaceted

public FACETEDTYPE getFaceted()

Description copied from interface: Facet

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.

Specified by:

getFaceted in interface Facet<FACETEDTYPE extends Faceted<?>>

setFaceted

public void setFaceted(FACETEDTYPE origin)

Set the origin on which this Facet will operate.

Specified by:

setFaceted in interface MutableFacet<FACETEDTYPE extends Faceted<?>>

uninstall

public boolean uninstall()

Description copied from interface: Facet

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

Specified by:

uninstall in interface Facet<FACETEDTYPE extends Faceted<?>>

hashCode

public int hashCode()

Facet instances are the same if they are registered to the same project.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object