org.apache.sling.models.factory

Interface ModelFactory

@ProviderType
public interface ModelFactory

The ModelFactory instantiates Sling Model classes similar to #adaptTo but will throw an exception in case instantiation fails for some reason.

Method Summary

Modifier and Type	Method and Description
boolean	canCreateFromAdaptable(Object adaptable, Class<?> type)
<ModelType> ModelType	createModel(Object adaptable, Class<ModelType> type) Instantiates the given Sling Model class from the given adaptable.
boolean	isModelClass(Class<?> type) Checks if a given type can be instantiated though Sling Models.
boolean	isModelClass(Object adaptable, Class<?> type) Deprecated. Use isModelClass(Class) instead!

Method Detail

createModel

@Nonnull
<ModelType> ModelType createModel(@Nonnull
                                           Object adaptable,
                                           @Nonnull
                                           Class<ModelType> type)
                                    throws MissingElementsException,
                                           InvalidAdaptableException,
                                           ModelClassException,
                                           PostConstructException,
                                           ValidationException,
                                           InvalidModelException

Instantiates the given Sling Model class from the given adaptable.

Parameters:

adaptable - the adaptable to use to instantiate the Sling Model Class

type - the class to instantiate

Returns:

a new instance for the required model (never null)

Throws:

MissingElementsException - in case no injector was able to inject some required values with the given types

InvalidAdaptableException - in case the given class cannot be instantiated from the given adaptable (different adaptable on the model annotation)

ModelClassException - in case the model could not be instantiated because model annotation was missing, reflection failed, no valid constructor was found or post-construct could not be called

PostConstructException - in case the post-construct method has thrown an exception itself

ValidationException - in case validation could not be performed for some reason (e.g. no validation information available)

InvalidModelException - in case the given model type could not be validated through the model validation

canCreateFromAdaptable

boolean canCreateFromAdaptable(@Nonnull
                               Object adaptable,
                               @Nonnull
                               Class<?> type)
                        throws ModelClassException

Parameters:

adaptable - the adaptable to check

type - the class to check

Returns:

true in case the given class can be created from the given adaptable

Throws:

ModelClassException - in case no class with the Model annotation adapts to the requested type

isModelClass

@Deprecated
boolean isModelClass(@Nonnull
                                 Object adaptable,
                                 @Nonnull
                                 Class<?> type)

Deprecated. Use isModelClass(Class) instead!

Parameters:

adaptable - the adaptable to check

type - the class to check

Returns:

false in case no class with the Model annotation adapts to the requested type

See Also:

Model

isModelClass

boolean isModelClass(@Nonnull
                     Class<?> type)

Checks if a given type can be instantiated though Sling Models. This checks that

• there is a class annotated with Model which adapts to the given type
• this class is registered as Sling Model (i.e. the package is listed in the "Sling-Model-Packages" header from the bundles manifest)

Only if both conditions are fulfilled this method will return true.

Parameters:

type - the class to check

Returns:

true in case the given type can be instantiated though Sling Models.