Module dev.metaschema.databind

Package dev.metaschema.databind

Class PostProcessingModuleLoaderStrategy

java.lang.Object

dev.metaschema.databind.PostProcessingModuleLoaderStrategy

All Implemented Interfaces:

IBindingContext.IModuleLoaderStrategy, ModuleLoadingPostProcessor

public class PostProcessingModuleLoaderStrategy
extends Object
implements IBindingContext.IModuleLoaderStrategy

A module loader strategy that applies post-processors to loaded modules.

This strategy wraps another IBindingContext.IModuleLoaderStrategy and ensures that configured IModuleLoader.IModulePostProcessor instances are invoked on each module before it is registered. Post-processing is applied only once per module, even if the module is referenced multiple times.

Since:

2.0.0

Constructor Summary

Constructors

Constructor	Description
PostProcessingModuleLoaderStrategy(List<IModuleLoader.IModulePostProcessor> modulePostProcessors)	Construct a new post-processing module loader strategy using the default delegate strategy.
PostProcessingModuleLoaderStrategy(List<IModuleLoader.IModulePostProcessor> modulePostProcessors, IBindingContext.IModuleLoaderStrategy delegate)	Construct a new post-processing module loader strategy with a custom delegate.

Method Summary

Modifier and Type	Method	Description
Collection<IBindingContext.IBindingMatcher>	getBindingMatchers()	Get the matchers used to identify the bound class associated with the definition's root name.
IBoundDefinitionModelComplex	getBoundDefinitionForClass(Class<? extends IBoundObject> clazz, IBindingContext bindingContext)	Get the IBoundDefinitionModel instance associated with the provided Java class.
protected List<IModuleLoader.IModulePostProcessor>	getModulePostProcessors()	Get the configured module post-processors.
IBoundModule	loadModule(Class<? extends IBoundModule> clazz, IBindingContext bindingContext)	Load the bound Metaschema module represented by the provided class.
void	postProcessModule(IModule module, IBindingContext bindingContext)	Perform post-processing on the module.
protected void	processModule(IModule module)	Perform post-processing on the provided module.
IBoundModule	registerModule(IModule module, IBindingContext bindingContext)	Registers the provided Metaschema module.

Methods inherited from class java.lang.Object

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

Constructor Details

PostProcessingModuleLoaderStrategy

public PostProcessingModuleLoaderStrategy(@NonNull
 List<IModuleLoader.IModulePostProcessor> modulePostProcessors)

Construct a new post-processing module loader strategy using the default delegate strategy.

Parameters:

modulePostProcessors - the post-processors to apply to loaded modules

PostProcessingModuleLoaderStrategy

public PostProcessingModuleLoaderStrategy(@NonNull
 List<IModuleLoader.IModulePostProcessor> modulePostProcessors,
 @NonNull
 IBindingContext.IModuleLoaderStrategy delegate)

Construct a new post-processing module loader strategy with a custom delegate.

Parameters:

modulePostProcessors - the post-processors to apply to loaded modules

delegate - the delegate strategy to use for actual module loading and registration

Method Details

getModulePostProcessors

@NonNull
protected List<IModuleLoader.IModulePostProcessor> getModulePostProcessors()

Get the configured module post-processors.

Returns:

an unmodifiable list of post-processors

loadModule

public IBoundModule loadModule(Class<? extends IBoundModule> clazz,
 IBindingContext bindingContext)

Description copied from interface: IBindingContext.IModuleLoaderStrategy

Load the bound Metaschema module represented by the provided class.

This is the primary entry point for loading an already bound module. This method must ensure that the loaded module is post-processed and registered.

Implementations are allowed to return a cached instance if the module has already been loaded by this method.

Specified by:

loadModule in interface IBindingContext.IModuleLoaderStrategy

Parameters:

clazz - the Module class

bindingContext - the Metaschema binding context used to load bound resources

Returns:

the module

postProcessModule

public void postProcessModule(IModule module,
 IBindingContext bindingContext)

Description copied from interface: IBindingContext.IModuleLoaderStrategy

Perform post-processing on the module.

Specified by:

postProcessModule in interface IBindingContext.IModuleLoaderStrategy

Specified by:

postProcessModule in interface ModuleLoadingPostProcessor

Parameters:

module - the Metaschema module to post-process

bindingContext - the Metaschema binding context used to load bound resources

registerModule

public IBoundModule registerModule(IModule module,
 IBindingContext bindingContext)
                            throws MetaschemaException

Description copied from interface: IBindingContext.IModuleLoaderStrategy

Registers the provided Metaschema module.

If this module has not been post-processed, this method is expected to drive post-processing first.

If the provided instance is not an instance of IBoundModule, then annotated Java classes for this module will be generated, compiled, and loaded based on the provided Module.

Specified by:

registerModule in interface IBindingContext.IModuleLoaderStrategy

Parameters:

module - the Module module to generate classes for

bindingContext - the Metaschema binding context used to load bound resources

Returns:

the registered module, which may be a different instance than what was provided if dynamic compilation was performed

Throws:

MetaschemaException - if an error occurred while dynamically binding the provided module

processModule

protected void processModule(@NonNull
 IModule module)

Perform post-processing on the provided module.

Parameters:

module - the module to post process

getBindingMatchers

public Collection<IBindingContext.IBindingMatcher> getBindingMatchers()

Description copied from interface: IBindingContext.IModuleLoaderStrategy

Get the matchers used to identify the bound class associated with the definition's root name.

Specified by:

getBindingMatchers in interface IBindingContext.IModuleLoaderStrategy

Returns:

the matchers

getBoundDefinitionForClass

public IBoundDefinitionModelComplex getBoundDefinitionForClass(Class<? extends IBoundObject> clazz,
 IBindingContext bindingContext)

Description copied from interface: IBindingContext.IModuleLoaderStrategy

Get the IBoundDefinitionModel instance associated with the provided Java class.

Typically the class will have a MetaschemaAssembly or MetaschemaField annotation.

Specified by:

getBoundDefinitionForClass in interface IBindingContext.IModuleLoaderStrategy

Parameters:

clazz - the class binding to load

bindingContext - the Metaschema binding context used to load bound resources

Returns:

the associated class binding instance