org.jboss.forge.addon.facets

Interface Faceted<FACETTYPE extends Facet<?>>

Type Parameters:

FACETTYPE - the base Facet type supported by this Faceted type.

All Known Subinterfaces:

DirectoryResource, EnumConstantResource, FileResource<T>, GitIgnoreResource, InputComponent<IMPLTYPE,VALUETYPE>, JavaFieldResource, JavaMethodResource, JavaResource, JsonResource, MavenDependencyResource, MavenModelResource, MavenProfileResource, MavenRepositoryResource, MutableFaceted<FACETTYPE>, Project, Resource<T>, SelectComponent<IMPLTYPE,VALUETYPE>, UIInput<VALUETYPE>, UIInputMany<VALUETYPE>, UISelectMany<VALUETYPE>, UISelectOne<VALUETYPE>, URLResource, WriteableResource<T,R>, XMLResource

All Known Implementing Classes:

AbstractFaceted, AbstractFileResource, AbstractProject, AbstractResource, VirtualResource

public interface Faceted<FACETTYPE extends Facet<?>>

Author:

Ken Finnigan, Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
<F extends FACETTYPE> F	getFacet(Class<F> type) Return the instance of the requested Facet type, or throw a FacetNotFoundException if no Facet of that type is installed.
Iterable<FACETTYPE>	getFacets() Return a Iterable of the currently installed Facets.
<F extends FACETTYPE> Iterable<F>	getFacets(Class<F> type) Return a Iterable of the currently installed Facets matching the given type.
boolean	hasAllFacets(Class<? extends FACETTYPE>... facetDependencies) Return true if all specified facetDependencies are present; return false otherwise.
boolean	hasAllFacets(Iterable<Class<? extends FACETTYPE>> facetDependencies) Return true if all specified facetDependencies are present; return false otherwise.
boolean	hasFacet(Class<? extends FACETTYPE> type) Return true if a facet of the given type is present; return false otherwise.
<F extends FACETTYPE> boolean	supports(F facet) Return true if the given Facet is supported.

Method Detail

hasFacet

boolean hasFacet(Class<? extends FACETTYPE> type)

Return true if a facet of the given type is present; return false otherwise.

hasAllFacets

boolean hasAllFacets(Class<? extends FACETTYPE>... facetDependencies)

Return true if all specified facetDependencies are present; return false otherwise.

hasAllFacets

boolean hasAllFacets(Iterable<Class<? extends FACETTYPE>> facetDependencies)

Return true if all specified facetDependencies are present; return false otherwise.

getFacet

<F extends FACETTYPE> F getFacet(Class<F> type)
                             throws FacetNotFoundException

Return the instance of the requested Facet type, or throw a FacetNotFoundException if no Facet of that type is installed.

Throws:

FacetNotFoundException

getFacets

Iterable<FACETTYPE> getFacets()

Return a Iterable of the currently installed Facets. Return an empty list if no facets of that type were found.

getFacets

<F extends FACETTYPE> Iterable<F> getFacets(Class<F> type)

Return a Iterable of the currently installed Facets matching the given type.

supports

<F extends FACETTYPE> boolean supports(F facet)

Return true if the given Facet is supported.