com.qcadoo.plugin.api

Class ModuleFactory<T extends Module>

java.lang.Object

com.qcadoo.plugin.api.ModuleFactory<T>

public abstract class ModuleFactory<T extends Module>
extends Object

Factory responsible for parsing descriptors and creating instances of Module.

Since:

0.4.0

See Also:

plugins and modules lifecycle

Constructor Summary

Constructors

Constructor and Description
ModuleFactory()

Method Summary

Modifier and Type	Method and Description
abstract String	getIdentifier() Identifier is used to distinguish the type of the module.
T	parse(String pluginIdentifier, org.jdom.Element element) Parses descriptor and creates instance of Module.
void	postInit() Callback is invoke once on application startup, after the Module.init().
void	preInit() Callback is invoke once on application startup, before the Module.init().

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleFactory

public ModuleFactory()

Method Detail

getIdentifier

public abstract String getIdentifier()

Identifier is used to distinguish the type of the module. It is equal to the name of the tag in section "modules" in plugin descriptor.

Returns:

module identifier

parse

public final T parse(String pluginIdentifier,
                     org.jdom.Element element)

Parses descriptor and creates instance of Module.

Parameters:

pluginIdentifier - plugin identifier

element - xml element describing module

Returns:

module instance

Throws:

ModuleException - when some exception occured

postInit

public void postInit()

Callback is invoke once on application startup, after the Module.init().

preInit

public void preInit()

Callback is invoke once on application startup, before the Module.init().