io.neba.api.spi

Interface ResourceModelFactory

public interface ResourceModelFactory

Represents a source for resource models. NEBA will register all services of this type to obtain the available resource models. The models will be tied to the scope of the providing service.

Since:

5.0.0

Author:

Olaf Otto

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResourceModelFactory.ContentToModelMappingCallback<T> A callback to be invoked when the model is ready for content-to-model mapping.
static interface	ResourceModelFactory.ModelDefinition<T>

Method Summary

Modifier and Type	Method and Description
Collection<ResourceModelFactory.ModelDefinition<?>>	getModelDefinitions()
<T> T	provideModel(ResourceModelFactory.ModelDefinition<T> modelDefinition, ResourceModelFactory.ContentToModelMappingCallback<T> callback)

Method Detail

getModelDefinitions

@Nonnull
Collection<ResourceModelFactory.ModelDefinition<?>> getModelDefinitions()

Returns:

A list of all model definitions suitable for #provideModel(ModelDefinition, ContentToModelMappingCallback) (ModelDefinition, ContentToModelMappingCallback) model} resolution. Never null but rather an empty collection.

provideModel

<T> T provideModel(@Nonnull
                   ResourceModelFactory.ModelDefinition<T> modelDefinition,
                   @Nonnull
                   ResourceModelFactory.ContentToModelMappingCallback<T> callback)

Parameters:

modelDefinition - must not be null.

callback - the callback to invoke when the model is ready for content-to-object mapping. After the invocation, the resource originally adapted to the model has been mapped to the model. This allows the factory to stay in control the model life cycle, for instance to invoke PostConstruct methods after completion of content-to-model mapping.