Module watamebot

Package net.foxgenesis.watame.plugin

Class UntrustedPluginLoader<T>

java.lang.Object

net.foxgenesis.watame.plugin.UntrustedPluginLoader<T>

All Implemented Interfaces:

AutoCloseable

public class UntrustedPluginLoader<T>
extends Object
implements AutoCloseable

Constructor Summary

Constructors

Constructor	Description
UntrustedPluginLoader(Class<T> pluginClass)
UntrustedPluginLoader(Class<T> pluginClass, File folder)	Create a new UntrustedPluginLoader instance and set the directory to use.
UntrustedPluginLoader(Class<T> pluginClass, File folder, boolean mkdirs)	Create a new UntrustedPluginLoader instance and set the directory to use.

Method Summary

Modifier and Type	Method	Description
void	close()
Class<T>	getPluginClass()	Get the class of UntrustedPluginLoader.
File	getPluginDirectory()	Get the plugin folder currently selected.
Collection<T>	getPlugins()	Get all plugins of type UntrustedPluginLoader in the selected folder.
Collection<T>	getPlugins(Function<ServiceLoader.Provider<T>,T> providerMap)	Get all plugins of type UntrustedPluginLoader in the selected folder.
void	setPluginDirectory(File folder, boolean mkdirs)	Set the plugin folder to use during class search.

Methods inherited from class java.lang.Object

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

Constructor Details

UntrustedPluginLoader

public UntrustedPluginLoader(@Nonnull
 Class<T> pluginClass)

UntrustedPluginLoader

public UntrustedPluginLoader(@Nonnull
 Class<T> pluginClass,
 @Nonnull
 File folder)

Create a new UntrustedPluginLoader instance and set the directory to use.

This constructor is effectively equivalent to:

 new PluginLoader(folder, false)
 

Parameters:

folder - - The File to search for plugins in.

UntrustedPluginLoader

public UntrustedPluginLoader(@Nonnull
 Class<T> pluginClass,
 @Nonnull
 File folder,
 boolean mkdirs)

Create a new UntrustedPluginLoader instance and set the directory to use.

Parameters:

folder - - The File to search for plugins in.

mkdirs - - If folder does not exist, should a new one be made

Method Details

getPlugins

public Collection<T> getPlugins()

Get all plugins of type UntrustedPluginLoader in the selected folder.

This method is effectively equivalent to:

 getPlugins(Provider::get)
 

Returns:

A Collection of UntrustedPluginLoader

Throws:

ServiceConfigurationError - if the service type is not accessible to the caller or the caller is in an explicit module and its module descriptor does not declare that it uses service

See Also:

• getPlugins(Function)

getPlugins

public Collection<T> getPlugins(Function<ServiceLoader.Provider<T>,T> providerMap)

Get all plugins of type UntrustedPluginLoader in the selected folder.

Parameters:

providerMap - - Function to map a ServiceLoader.Provider to UntrustedPluginLoader

Returns:

A Collection of UntrustedPluginLoader

Throws:

ServiceConfigurationError - if the service type is not accessible to the caller or the caller is in an explicit module and its module descriptor does not declare that it uses service

See Also:

• getPlugins()

setPluginDirectory

public void setPluginDirectory(@Nonnull
 File folder,
 boolean mkdirs)

Set the plugin folder to use during class search.

Parameters:

folder - - The File to search in

mkdirs - - If folder does not exist, should a new directory be made

Throws:

NullPointerException - Thrown if folder is null.

IllegalArgumentException - Thrown when folder does not exist and mkdirs is false or, folder is not a file directory.

getPluginDirectory

public File getPluginDirectory()

Get the plugin folder currently selected.

Returns:

Returns the File selected as the plugin directory

getPluginClass

public Class<T> getPluginClass()

Get the class of UntrustedPluginLoader.

Returns:

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception