com.suncode.plugin.framework

Interface ModuleFactory

public interface ModuleFactory

Fabryka modułów. Używana do tworzenia modułów o podanym typie. Mapuje typ modułu do klasy implementującej Module. Dla każdej wtyczki tworzona jest nowa instancja tego modułu.

Author:

Cezary Kozar

Method Summary

Methods

Modifier and Type	Method and Description
Module<?>	createModule(String type) Tworzy instancje modułu na podstawie przesłanej definicji modułu, jeżeli podany moduł jest zarejestowany.
Class<? extends Module<?>>	getModuleClass(String type) Zwraca zarejestrowaną klasę dla podanego typu modułu
void	initializeModule(String type, Module<?> module) Inicjalizuje podany moduł.
void	registerModule(String type, Class<? extends Module<?>> moduleClass) Rejestracja modułu o podanym typie.
void	registerPluginModule(String type, Plugin plugin, Class<? extends Module<?>> moduleClass) Rejestracja modułu wtyczki.
void	unregisterModule(String type) Usuwa z rejestru moduł o podanym typie

Method Detail

getModuleClass

Class<? extends Module<?>> getModuleClass(String type)

Zwraca zarejestrowaną klasę dla podanego typu modułu

Parameters:

type - typ modułu

Returns:

klasa implementująca Module lub null, jeżeli moduł o podanym typie nie został zarejestrowany

createModule

Module<?> createModule(String type)

Tworzy instancje modułu na podstawie przesłanej definicji modułu, jeżeli podany moduł jest zarejestowany. Zwrócona instancja nie jest jeszcze w pełni zainicjalizowana (zależności nie są jeszcze wstrzyknięte).

Parameters:

type - typ modułu

Returns:

niezainicjalizowana instancja modułu lub null jeżeli moduł nie został jeszcze zarejestrowany

initializeModule

void initializeModule(String type,
                    Module<?> module)

Inicjalizuje podany moduł. W praktyce oznacza to, że wszystkie zależności są dynamicznie wstrzykiwane.

Parameters:

type - typ modułu

module - instancja modułu

registerModule

void registerModule(String type,
                  Class<? extends Module<?>> moduleClass)

Rejestracja modułu o podanym typie. Do wstrzykiwania zależności użyty będzie kontekst mechanizmu wtyczek.

Parameters:

type - typ modułu

moduleClass - klasa modułu

registerPluginModule

void registerPluginModule(String type,
                        Plugin plugin,
                        Class<? extends Module<?>> moduleClass)

Rejestracja modułu wtyczki. Do wstrzykiwania zależności tego modułu użyty będzie kontekst wtyczki.

Parameters:

plugin - wtyczka rejestrująca moduł

type - typ modułu

moduleClass - klasa modułu

unregisterModule

void unregisterModule(String type)

Usuwa z rejestru moduł o podanym typie

Parameters:

type - typ modułu