org.jboss.forge.facets

Interface FacetFactory

@Exported
public interface FacetFactory

Responsible for instantiation of new Facet instances.

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> FACET	create(Class<FACET> type) Create a new instance of the given Facet type.
<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> FACET	create(Class<FACET> type, E origin) Create a new instance of the given Facet type.
<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> Iterable<FACET>	createFacets(Class<FACET> type) Get all instantiable Facet instances implementing the given Facet type.
<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> Iterable<FACET>	createFacets(Class<FACET> type, E origin) Get all instantiable Facet instances implementing the given Facet type.
<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> FACET	install(Class<FACET> type, E origin) Create and installs a new instance of the given Facet type.

Method Detail

create

<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> FACET create(Class<FACET> type)
                           throws FacetNotFoundException

Create a new instance of the given Facet type.

Throws:

FacetNotFoundException - if no implementation can be found.

create

<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> FACET create(Class<FACET> type,
                                                                          E origin)
                           throws FacetNotFoundException

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

Throws:

FacetNotFoundException - if no implementation can be found.

createFacets

<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> Iterable<FACET> createFacets(Class<FACET> type)

Get all instantiable Facet instances implementing the given Facet type. Returns an empty Iterable if no matching implementations can be found.

createFacets

<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> Iterable<FACET> createFacets(Class<FACET> type,
                                                                                          E origin)

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

install

<FACET extends Facet<E>,E extends Faceted<? extends Facet<?>>> FACET install(Class<FACET> type,
                                                                           E origin)
                            throws FacetNotFoundException

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

Throws:

FacetNotFoundException - if no implementation can be found.