Class PluginStateImpl

java.lang.Object

com.biglybt.pifimpl.local.PluginStateImpl

All Implemented Interfaces:

PluginState

public class PluginStateImpl
extends Object
implements PluginState

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	disabled
(package private) boolean	failed
private PluginInitializer	initialiser
(package private) boolean	operational
private PluginInterfaceImpl	pi
(package private) boolean	restart_pending

Constructor Summary

Constructors

Constructor	Description
PluginStateImpl(PluginInterfaceImpl pi, PluginInitializer initialiser)

Method Summary

Modifier and Type	Method	Description
boolean	hasFailed()	Returns true if there was a problem loading or initialising the plugin.
boolean	isBuiltIn()	Built-in plugins are those used internally by the client, for example the UPnP plugin.
boolean	isDisabled()	Returns true if the plugin has been marked as disabled, and prevented from initialising.
boolean	isInitialisationComplete()
boolean	isLoadedAtStartup()	Returns true if the plugin is set to load at startup, false otherwise.
boolean	isMandatory()	Whether or not this is a mandatory plugin.
boolean	isOperational()	Returns true if the plugin is running, returns false if the plugin isn't running for some reason.
boolean	isRestartPending()
boolean	isShared()
boolean	isUnloadable()
boolean	isUnloaded()
void	reload()
void	setDisabled(boolean _disabled)	Sets whether the plugin can be loaded or not.
void	setLoadedAtStartup(boolean load_at_startup)	Sets whether the plugin is loaded at startup or not.
(package private) void	setOperational(boolean b, boolean reloading)
void	setRestartPending(boolean b)
void	uninstall()	Uninstall this plugin if it has been loaded from a plugin directory.
void	unload()
protected void	unload(boolean for_reload)

Methods inherited from class Object

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

Field Details

pi

private PluginInterfaceImpl pi

initialiser

private PluginInitializer initialiser

disabled

private boolean disabled

operational

boolean operational

failed

boolean failed

restart_pending

boolean restart_pending

Constructor Details

PluginStateImpl

public PluginStateImpl(PluginInterfaceImpl pi,
 PluginInitializer initialiser)

Method Details

setLoadedAtStartup

public void setLoadedAtStartup(boolean load_at_startup)

Description copied from interface: PluginState

Sets whether the plugin is loaded at startup or not.

Specified by:

setLoadedAtStartup in interface PluginState

isLoadedAtStartup

public boolean isLoadedAtStartup()

Description copied from interface: PluginState

Returns true if the plugin is set to load at startup, false otherwise.

Specified by:

isLoadedAtStartup in interface PluginState

hasFailed

public boolean hasFailed()

Description copied from interface: PluginState

Returns true if there was a problem loading or initialising the plugin.

Specified by:

hasFailed in interface PluginState

setDisabled

public void setDisabled(boolean _disabled)

Description copied from interface: PluginState

Sets whether the plugin can be loaded or not. If you are trying to affect if the plugin can be loaded at startup - use PluginState.setLoadedAtStartup(boolean) instead. This needs to be called prior to a plugin's initialisation to take effect.

Specified by:

setDisabled in interface PluginState

Parameters:

_disabled -

isDisabled

public boolean isDisabled()

Description copied from interface: PluginState

Returns true if the plugin has been marked as disabled, and prevented from initialising.

Specified by:

isDisabled in interface PluginState

isBuiltIn

public boolean isBuiltIn()

Description copied from interface: PluginState

Built-in plugins are those used internally by the client, for example the UPnP plugin.

Specified by:

isBuiltIn in interface PluginState

isMandatory

public boolean isMandatory()

Description copied from interface: PluginState

Whether or not this is a mandatory plugin. Mandatory plugins take priority over update checks, for example, over optional ones.

Specified by:

isMandatory in interface PluginState

setOperational

void setOperational(boolean b,
 boolean reloading)

isOperational

public boolean isOperational()

Description copied from interface: PluginState

Returns true if the plugin is running, returns false if the plugin isn't running for some reason.

Specified by:

isOperational in interface PluginState

isShared

public boolean isShared()

Specified by:

isShared in interface PluginState

isInitialisationComplete

public boolean isInitialisationComplete()

Specified by:

isInitialisationComplete in interface PluginState

isRestartPending

public boolean isRestartPending()

Specified by:

isRestartPending in interface PluginState

setRestartPending

public void setRestartPending(boolean b)

Specified by:

setRestartPending in interface PluginState

reload

public void reload()
            throws PluginException

Specified by:

reload in interface PluginState

Throws:

PluginException

uninstall

public void uninstall()
               throws PluginException

Description copied from interface: PluginState

Uninstall this plugin if it has been loaded from a plugin directory. Deletes the plugin directory.

Specified by:

uninstall in interface PluginState

Throws:

PluginException

isUnloaded

public boolean isUnloaded()

Specified by:

isUnloaded in interface PluginState

unload

public void unload()
            throws PluginException

Specified by:

unload in interface PluginState

Throws:

PluginException

unload

protected void unload(boolean for_reload)
               throws PluginException

Throws:

PluginException

isUnloadable

public boolean isUnloadable()

Specified by:

isUnloadable in interface PluginState