org.jboss.forge.addon.facets.constraints

Class FacetInspector

java.lang.Object

org.jboss.forge.addon.facets.constraints.FacetInspector

public abstract class FacetInspector
extends Object

Used to inspect types that may or may not depend on Facets or packaging types.

Author:

Lincoln Baxter, III

Constructor Summary

Constructors

Constructor and Description
FacetInspector()

Method Summary

Methods

Modifier and Type	Method and Description
static <FACETEDTYPE extends Faceted<FACETTYPE>,FACETTYPE extends Facet<FACETEDTYPE>> Set<Class<FACETTYPE>>	getAllOptionalFacets(Class<FACETTYPE> inspectedType) Inspect the given Class for all FacetConstraintType.OPTIONAL dependency Facet types.
static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>>	getAllRelatedFacets(Class<?> inspectedType) Inspect the given Class for all Facet types from all FacetConstraint declarations.
static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>>	getAllRequiredFacets(Class<?> inspectedType) Inspect the given Class for all FacetConstraintType.REQUIRED dependency Facet types.
static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>>	getOptionalFacets(Class<?> inspectedType) Inspect the given Class for any FacetConstraintType.OPTIONAL dependency Facet types.
static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>>	getRequiredFacets(Class<?> inspectedType) Inspect the given Class for any FacetConstraintType.REQUIRED dependency Facet types.
static <FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean	hasCircularConstraints(Class<?> inspectedType) Inspect the given Class, and return true if any circular dependencies are detected between any FacetConstraint declarations.
static <FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean	isConstraintSatisfied(Faceted<FACETTYPE> faceted, Set<Class<FACETTYPE>> requiredFacets) Inspect the given Class, and return true if all declared constraints have been satisfied.

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetInspector

public FacetInspector()

Method Detail

isConstraintSatisfied

public static <FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean isConstraintSatisfied(Faceted<FACETTYPE> faceted,
                                                                                                  Set<Class<FACETTYPE>> requiredFacets)

Inspect the given Class, and return true if all declared constraints have been satisfied.

hasCircularConstraints

public static <FACETEDTYPE extends Faceted<?>,FACETTYPE extends Facet<FACETEDTYPE>> boolean hasCircularConstraints(Class<?> inspectedType)

Inspect the given Class, and return true if any circular dependencies are detected between any FacetConstraint declarations.

getOptionalFacets

public static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>> getOptionalFacets(Class<?> inspectedType)

Inspect the given Class for any FacetConstraintType.OPTIONAL dependency Facet types.

getRequiredFacets

public static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>> getRequiredFacets(Class<?> inspectedType)

Inspect the given Class for any FacetConstraintType.REQUIRED dependency Facet types.

getAllOptionalFacets

public static <FACETEDTYPE extends Faceted<FACETTYPE>,FACETTYPE extends Facet<FACETEDTYPE>> Set<Class<FACETTYPE>> getAllOptionalFacets(Class<FACETTYPE> inspectedType)

Inspect the given Class for all FacetConstraintType.OPTIONAL dependency Facet types. This method inspects the entire constraint tree.

getAllRequiredFacets

public static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>> getAllRequiredFacets(Class<?> inspectedType)

Inspect the given Class for all FacetConstraintType.REQUIRED dependency Facet types. This method inspects the entire constraint tree.

getAllRelatedFacets

public static <FACETTYPE extends Facet<?>> Set<Class<FACETTYPE>> getAllRelatedFacets(Class<?> inspectedType)

Inspect the given Class for all Facet types from all FacetConstraint declarations. This method inspects the entire constraint tree.