Package com.thewinterframework.module

Class PluginComponentModule

java.lang.Object

com.thewinterframework.wire.module.AbstractProcessorModule

com.thewinterframework.module.PluginComponentModule

All Implemented Interfaces:

com.google.inject.Module, PluginModule, ProcessorModule

public class PluginComponentModule
extends AbstractProcessorModule

Module for plugin components.

This module scans for classes annotated with ModuleComponent and binds them to the injector.

Field Summary

Fields inherited from class com.thewinterframework.wire.module.AbstractProcessorModule

activeComponents, moduleAnnotation, wire

Constructor Summary

Constructors

Constructor	Description
PluginComponentModule()

Method Summary

Modifier and Type	Method	Description
void	configure(com.google.inject.Binder binder)
List<Class<? extends PluginModule>>	depends(WinterPlugin plugin)	List of modules that this module depends on
boolean	onDisable(WinterPlugin plugin)	Called when the plugin is disabled NOTE: Plugin injections are available at this point
boolean	onEnable(WinterPlugin plugin)	Called when the plugin is enabled NOTE: Plugin injections are available at this point
boolean	onLoad(WinterPlugin plugin)	Called when the plugin is loaded NOTE: Plugin injections are not available at this point

Methods inherited from class com.thewinterframework.wire.module.AbstractProcessorModule

disableComponent, enableComponent, evaluateConditions, initWire, registerComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thewinterframework.plugin.module.PluginModule

before

Constructor Details

PluginComponentModule

public PluginComponentModule()

Method Details

depends

public List<Class<? extends PluginModule>> depends(WinterPlugin plugin)

Description copied from interface: PluginModule

List of modules that this module depends on

Parameters:

plugin - the plugin instance which is loaded

Returns:

list of modules that this module depends on, and will be loaded before this module

onLoad

public boolean onLoad(WinterPlugin plugin)

Description copied from interface: PluginModule

Called when the plugin is loaded
NOTE: Plugin injections are not available at this point

Specified by:

onLoad in interface PluginModule

Overrides:

onLoad in class AbstractProcessorModule

Parameters:

plugin - the plugin instance which is loaded

onEnable

public boolean onEnable(WinterPlugin plugin)

Description copied from interface: PluginModule

Called when the plugin is enabled
NOTE: Plugin injections are available at this point

Specified by:

onEnable in interface PluginModule

Overrides:

onEnable in class AbstractProcessorModule

Parameters:

plugin - the plugin instance which is enabled

onDisable

public boolean onDisable(WinterPlugin plugin)

Description copied from interface: PluginModule

Called when the plugin is disabled
NOTE: Plugin injections are available at this point

Specified by:

onDisable in interface PluginModule

Overrides:

onDisable in class AbstractProcessorModule

Parameters:

plugin - the plugin instance which is disabled

configure

public void configure(com.google.inject.Binder binder)