Package org.pf4j

Class PluginWrapper

java.lang.Object

org.pf4j.PluginWrapper

public class PluginWrapper
extends java.lang.Object

A wrapper over plugin instance.

Field Summary

Fields

Modifier and Type	Field	Description
private PluginDescriptor	descriptor
(package private) Plugin	plugin
private java.lang.ClassLoader	pluginClassLoader
private PluginFactory	pluginFactory
private PluginManager	pluginManager
private java.nio.file.Path	pluginPath
private PluginState	pluginState
private RuntimeMode	runtimeMode

Constructor Summary

Constructors

Constructor	Description
PluginWrapper(PluginManager pluginManager, PluginDescriptor descriptor, java.nio.file.Path pluginPath, java.lang.ClassLoader pluginClassLoader)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
PluginDescriptor	getDescriptor()	Returns the plugin descriptor.
Plugin	getPlugin()
java.lang.ClassLoader	getPluginClassLoader()	Returns the plugin class loader used to load classes and resources for this plug-in.
java.lang.String	getPluginId()	Shortcut
PluginManager	getPluginManager()	Returns the plugin manager.
java.nio.file.Path	getPluginPath()	Returns the path of this plugin.
PluginState	getPluginState()
RuntimeMode	getRuntimeMode()
int	hashCode()
void	setPluginFactory(PluginFactory pluginFactory)
void	setPluginState(PluginState pluginState)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

pluginManager

private PluginManager pluginManager

descriptor

private PluginDescriptor descriptor

pluginPath

private java.nio.file.Path pluginPath

pluginClassLoader

private java.lang.ClassLoader pluginClassLoader

pluginFactory

private PluginFactory pluginFactory

pluginState

private PluginState pluginState

runtimeMode

private RuntimeMode runtimeMode

plugin

Plugin plugin

Constructor Detail

PluginWrapper

public PluginWrapper(PluginManager pluginManager,
                     PluginDescriptor descriptor,
                     java.nio.file.Path pluginPath,
                     java.lang.ClassLoader pluginClassLoader)

Method Detail

getPluginManager

public PluginManager getPluginManager()

Returns the plugin manager.

getDescriptor

public PluginDescriptor getDescriptor()

Returns the plugin descriptor.

getPluginPath

public java.nio.file.Path getPluginPath()

Returns the path of this plugin.

getPluginClassLoader

public java.lang.ClassLoader getPluginClassLoader()

Returns the plugin class loader used to load classes and resources for this plug-in. The class loader can be used to directly access plug-in resources and classes.

getPlugin

public Plugin getPlugin()

getPluginState

public PluginState getPluginState()

getRuntimeMode

public RuntimeMode getRuntimeMode()

getPluginId

public java.lang.String getPluginId()

Shortcut

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setPluginState

public void setPluginState(PluginState pluginState)

setPluginFactory

public void setPluginFactory(PluginFactory pluginFactory)