org.da.protoframework.custom

Interface CustomModuleFactory

public interface CustomModuleFactory

The factory used to create an manage custom modules.

Since:

0.6.12

Method Summary

Modifier and Type	Method and Description
Module	createModule(Application appli, java.lang.String name) Creates a custom module.
CustomModuleDefinition	createModuleDefinition(ApplicationDefinition appli, java.lang.String name, long id) Creates a custom module definition.
default java.util.Map<java.lang.String,java.lang.Class<?>>	getFrameworkPropertiesTypes() Return the framework properties supported by the factory and their associated property types.
default java.lang.Object	getFrameworkProperty(java.lang.String key) Return a framework property value.
default java.util.Set<java.lang.String>	getMandatoryModuleParameters() Return the keys for the mandatory module implementation parameters.
java.lang.Class<?>	getModuleDefinitionClass() Return the class used to define custom modules for this factory.
default java.util.Map<java.lang.String,java.lang.Class<?>>	getModuleParameterTypes() Return the module implementation parameters supported by the custom module and their associated types.
default void	setFrameworkProperty(java.lang.String key, java.lang.Object value) Set a framework property value.

Method Detail

getFrameworkPropertiesTypes

default java.util.Map<java.lang.String,java.lang.Class<?>> getFrameworkPropertiesTypes()

Return the framework properties supported by the factory and their associated property types. Return an empty Map by default.

Returns:

the framework properties supported by the factory and their associated property types

setFrameworkProperty

default void setFrameworkProperty(java.lang.String key,
                                  java.lang.Object value)

Set a framework property value. The value is guaranteed to be consistent with the type defined in getFrameworkPropertiesTypes(). Do nothing by default.

Parameters:

key - the framework property key

value - the framework property value

getFrameworkProperty

default java.lang.Object getFrameworkProperty(java.lang.String key)

Return a framework property value. The value is guaranteed to be consistent with the type defined in getFrameworkPropertiesTypes(). Return null by default.

Parameters:

key - the framework property key

Returns:

the framework property value

getModuleParameterTypes

default java.util.Map<java.lang.String,java.lang.Class<?>> getModuleParameterTypes()

Return the module implementation parameters supported by the custom module and their associated types. Return an empty Map by default.

Returns:

the module implementation parameters supported by the custom module and their associated types

See Also:

CustomModuleDefinition.setModuleParameter(java.lang.String, java.lang.Object)

getMandatoryModuleParameters

default java.util.Set<java.lang.String> getMandatoryModuleParameters()

Return the keys for the mandatory module implementation parameters. Return an empty set by default.

Returns:

the keys for the mandatory module implementation parameters

createModuleDefinition

CustomModuleDefinition createModuleDefinition(ApplicationDefinition appli,
                                              java.lang.String name,
                                              long id)

Creates a custom module definition.

Parameters:

appli - the application definition

name - the module name

id - the module ID

Returns:

the custom module definition

createModule

Module createModule(Application appli,
                    java.lang.String name)

Creates a custom module.

Parameters:

appli - the application

name - the module name

Returns:

the custom module

getModuleDefinitionClass

java.lang.Class<?> getModuleDefinitionClass()

Return the class used to define custom modules for this factory.

Returns:

the class