net.kyori.storm.plugin

Class PluginLoader

java.lang.Object

net.kyori.storm.plugin.PluginLoader

All Implemented Interfaces:

PluginFinder

public final class PluginLoader
extends java.lang.Object
implements PluginFinder

A plugin loader.

Constructor Summary

Constructors

Constructor and Description
PluginLoader(ClassLoaderInjector classLoaderInjector)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<PluginContainer>	all() Gets a collection of all plugins.
void	disable() Disable loaded containers.
void	enable() Enable loaded containers.
PluginContainer	find(java.lang.String id) Finds a plugin by the specified id.
void	findAll(java.nio.file.Path directory) Search directory for plugin candidates.
void	findClassPath(java.net.URLClassLoader loader) Search loader for plugin candidates.
boolean	load() Load plugin candidates into plugin containers.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginLoader

public PluginLoader(@NonNull
                    ClassLoaderInjector classLoaderInjector)

Method Detail

findAll

public void findAll(@NonNull
                    java.nio.file.Path directory)
             throws java.io.IOException

Search directory for plugin candidates.

Parameters:

directory - the directory to search

Throws:

java.io.IOException - if an exception occurred while searching for plugin candidates

findClassPath

public void findClassPath(@NonNull
                          java.net.URLClassLoader loader)
                   throws java.io.IOException

Search loader for plugin candidates.

Parameters:

loader - the class loader to search

Throws:

java.io.IOException - if an exception occurred while searching for plugin candidates

load

public boolean load()

Load plugin candidates into plugin containers.

Candidate sources will be injected into the classloader provided by the classloader injector.

Returns:

true if candidates have been loaded into containers, false if not

enable

public void enable()

Enable loaded containers.

disable

public void disable()

Disable loaded containers.

all

@NonNull
public java.util.Collection<PluginContainer> all()

Description copied from interface: PluginFinder

Gets a collection of all plugins.

Specified by:

all in interface PluginFinder

Returns:

a collection of plugins

find

@Nullable
public PluginContainer find(@NonNull
                                      java.lang.String id)

Description copied from interface: PluginFinder

Finds a plugin by the specified id.

Specified by:

find in interface PluginFinder

Parameters:

id - the id

Returns:

the plugin, or null if no plugin with the specified id could be found

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object