org.jboss.forge.addon.facets

Interface FacetFactory

public interface FacetFactory

Responsible for instantiation of new Facet instances.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
org.jboss.forge.furnace.spi.ListenerRegistration<FacetListener>	addFacetListener(FacetListener listener) Add a FacetListener to be notified when FacetEvent events occur.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE	create(FACETEDTYPE origin, Class<FACETTYPE> type) Create a new instance of the given Facet type.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> Iterable<FACETTYPE>	createFacets(FACETEDTYPE origin, Class<FACETTYPE> type) Get all instantiable Facet instances implementing the given Facet type.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE	install(FACETEDTYPE origin, Class<FACETTYPE> type) Create and installs a new instance of the given Facet type.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE	install(FACETEDTYPE origin, Class<FACETTYPE> type, org.jboss.forge.furnace.util.Predicate<FACETTYPE> filter) Create and installs a new instance of the given Facet type.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean	install(FACETEDTYPE origin, FACETTYPE facet) Install a Facet instance into the given Faceted origin.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean	install(FACETEDTYPE origin, FACETTYPE facet, org.jboss.forge.furnace.util.Predicate<FACETTYPE> filter) Install a Facet instance into the given Faceted origin.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE	register(FACETEDTYPE origin, Class<FACETTYPE> type) Register a Facet type into the given Faceted origin.
<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean	register(FACETEDTYPE origin, FACETTYPE facet) Register a Facet instance into the given Faceted origin.

Method Detail

create

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE create(FACETEDTYPE origin,
                                                                                       Class<FACETTYPE> type)
                                                                                throws FacetNotFoundException,
                                                                                       FacetIsAmbiguousException

Create a new instance of the given Facet type. If it is also an instance of MutableFacet, then use the given origin instance as the Facet.getFaceted().

Throws:

FacetNotFoundException - if no implementation can be found.

FacetIsAmbiguousException - if the given facet type is an interface or abstract class, and multiple implementations were found.

createFacets

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> Iterable<FACETTYPE> createFacets(FACETEDTYPE origin,
                                                                                                       Class<FACETTYPE> type)

Get all instantiable Facet instances implementing the given Facet type. If it is also an instance of MutableFacet, then use the given origin instance as the Facet.getFaceted(). Returns an empty Iterable if no matching implementations can be found.

install

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE install(FACETEDTYPE origin,
                                                                                        Class<FACETTYPE> type)
                                                                                 throws FacetNotFoundException,
                                                                                        IllegalStateException,
                                                                                        FacetIsAmbiguousException

Create and installs a new instance of the given Facet type.

Returns:

the new Facet instance. (Never null.)

Throws:

FacetNotFoundException - if no implementation can be found.

FacetIsAmbiguousException - if the given facet type is an interface or abstract class, and multiple implementations were found.

IllegalStateException - if installation failed

install

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE install(FACETEDTYPE origin,
                                                                                        Class<FACETTYPE> type,
                                                                                        org.jboss.forge.furnace.util.Predicate<FACETTYPE> filter)
                                                                                 throws FacetNotFoundException,
                                                                                        IllegalStateException,
                                                                                        FacetIsAmbiguousException

Create and installs a new instance of the given Facet type.

Returns:

the new Facet instance. (Never null.)

Throws:

FacetNotFoundException - if no implementation can be found.

FacetIsAmbiguousException - if the given facet type is an interface or abstract class, and multiple implementations were found.

IllegalStateException - if installation failed

install

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean install(FACETEDTYPE origin,
                                                                                      FACETTYPE facet)
                                                                               throws IllegalArgumentException,
                                                                                      IllegalStateException

Install a Facet instance into the given Faceted origin.

Returns:

true if installation was successful; false if installation failed.

Throws:

IllegalStateException - if installation failed

IllegalArgumentException - when the given Facet.getFaceted() is not equal to the specified Faceted origin instance, or if the given Faceted type does not implement MutableFaceted.

install

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean install(FACETEDTYPE origin,
                                                                                      FACETTYPE facet,
                                                                                      org.jboss.forge.furnace.util.Predicate<FACETTYPE> filter)
                                                                               throws IllegalArgumentException,
                                                                                      IllegalStateException

Install a Facet instance into the given Faceted origin.

Returns:

true if installation was successful; false if installation failed.

Throws:

IllegalStateException - if installation failed

IllegalArgumentException - when the given Facet.getFaceted() is not equal to the specified Faceted origin instance, or if the given Faceted type does not implement MutableFaceted.

register

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> FACETTYPE register(FACETEDTYPE origin,
                                                                                         Class<FACETTYPE> type)
                                                                                  throws FacetNotFoundException,
                                                                                         IllegalStateException,
                                                                                         FacetIsAmbiguousException,
                                                                                         IllegalArgumentException

Register a Facet type into the given Faceted origin. (Facets may be registered when their installation requirements have already been met.)

Returns:

the new Facet instance. (Never null.)

Throws:

IllegalArgumentException - when the given Facet.getFaceted() is not equal to the specified Faceted origin instance, or if the given Faceted type does not implement MutableFaceted.

FacetNotFoundException - if no implementation can be found.

FacetIsAmbiguousException - if the given facet type is an interface or abstract class, and multiple implementations were found.

IllegalStateException - if installation failed.

register

<FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean register(FACETEDTYPE origin,
                                                                                       FACETTYPE facet)
                                                                                throws IllegalArgumentException

Register a Facet instance into the given Faceted origin. (Facets may be registered when their installation requirements have already been met.)

Returns:

true if registration was successful; false if installation failed.

Throws:

IllegalArgumentException - when the given Facet.getFaceted() is not equal to the specified Faceted origin instance, or if the given Faceted type does not implement MutableFaceted.

addFacetListener

org.jboss.forge.furnace.spi.ListenerRegistration<FacetListener> addFacetListener(FacetListener listener)

Add a FacetListener to be notified when FacetEvent events occur.

See Also:

FacetListener