com.github.unafraid.plugins

Class PluginRepository<T extends AbstractPlugin>

java.lang.Object

com.github.unafraid.plugins.PluginRepository<T>

Type Parameters:

T - refers to your own AbstractPlugin implementation abstract class, or you can use the original also

public class PluginRepository<T extends AbstractPlugin>
extends java.lang.Object

This is the class that scans for available plugins.
You can assume that it is the plugin manager. However it is a little but more.

Constructor Summary

Constructors

Constructor and Description
PluginRepository()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,T>>	getAllPlugins() Gets a Map view of all plugins.
T	getAvailablePlugin(java.lang.String name) Gets an available plugin by its name.
java.util.stream.Stream<T>	getAvailablePlugins() Gets a Stream view of available plugins.
java.lang.ClassLoader	getClassLoader(T plugin) Gets a class loader by the plugin.
void	scan(java.lang.Class<T> pluginClass) This method scans your classpath for the available plugins that can be initialized. If you aren't using IDE, you may drop your plugin JARs into "plugins" directory.
void	startAll() Starts all initialized plugins and setting them to installed.
void	stopAll() Stops all plugins.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginRepository

public PluginRepository()

Method Detail

scan

public final void scan(java.lang.Class<T> pluginClass)

This method scans your classpath for the available plugins that can be initialized.
If you aren't using IDE, you may drop your plugin JARs into "plugins" directory.

Parameters:

pluginClass - here you shall provide the very same class you provided above as T

getAllPlugins

public final java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,T>> getAllPlugins()

Gets a Map view of all plugins.

Returns:

all plugins

startAll

public void startAll()

Starts all initialized plugins and setting them to installed.

stopAll

public void stopAll()

Stops all plugins.

getAvailablePlugin

public T getAvailablePlugin(java.lang.String name)

Gets an available plugin by its name.

Parameters:

name - the plugin's name

Returns:

available plugin

getAvailablePlugins

public final java.util.stream.Stream<T> getAvailablePlugins()

Gets a Stream view of available plugins.

Returns:

available plugins

getClassLoader

public final java.lang.ClassLoader getClassLoader(T plugin)

Gets a class loader by the plugin.

Parameters:

plugin - the plugin

Returns:

class loader