com.github.unafraid.plugins

Class AbstractPlugin

java.lang.Object

com.github.unafraid.plugins.AbstractPlugin

public abstract class AbstractPlugin
extends java.lang.Object

This class is the parent class of all plugins.
Contains several event hooks you may implement to your own plugin.
Whenever you make a new plugin, please
do not forget to invoke init() in the constructor of your plugin. Otherwise it will not work!

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.nio.file.Path	getAbsolutePath(java.lang.String... paths) Gets the absolute path of the parameter.
java.lang.String	getAbsolutePathString(java.lang.String... paths) Gets the string version of getAbsolutePath(String...), uses Path.toString().
abstract java.lang.String	getAuthor() Gets the name of the author. Usage of String.intern() is recommend if you have multiple plugins under your name.
PluginConditions	getConditions() Gets the plugin condition holder.
abstract java.lang.String	getCreatedAt() Gets the creation date of this plugin.
abstract java.lang.String	getDescription() Gets the plugin's description. Feel free to provide some short details of your plugin.
FileInstaller	getFileInstaller() Gets the file installer.
java.util.List<IPluginInstaller>	getInstallers() Gets a list of the plugin installers that implements IPluginInstaller.
PluginMigrations	getMigrations() Gets the plugin migrations storage.
abstract java.lang.String	getName() Gets the name of the plugin. People often use Class.getSimpleName() but you are allowed to use your own naming also.
int	getPriority() Gets plugin's priority.
java.nio.file.Path	getRelativePath(java.lang.String... paths) Gets the relative path of the given parameters.
java.lang.String	getRelativePathString(java.lang.String... paths) Gets the string version of getRelativePath(String...), uses Path.toString().
PluginState	getState() Gets the actual state of the plugin.
abstract int	getVersion() Gets the actual version of this plugin.
int	hashCode()
protected void	init() A mandatory method that must be triggered in the constructor of your plugin. Sets up the plugin's environment related things and changed the plugin's state from available to initialized.
void	install() Installs your plugin or throws an exception.
void	migrate(int from, int to) Migrates your plugin from an older version to another.
protected abstract void	onInstall() Triggered whenever you install your plugin.
protected abstract void	onMigrate(int from, int to) Triggered whenever you migrate your plugin from a version to another.
protected abstract void	onStart() Triggered whenever your plugin starts.
void	onStateChanged(PluginState oldState, PluginState newState) An event triggered whenever the plugin's state is changed.
protected abstract void	onStop() Triggered whenever your plugin stops.
protected abstract void	onUninstall() Triggered whenever you uninstall your plugin.
protected boolean	setState(PluginState currentState, PluginState newState) Sets the state of the plugin.
protected abstract void	setup(FileInstaller fileInstaller, PluginMigrations migrations, PluginConditions pluginConditions) Triggered whenever the plugin is being initialized.
void	start() Starts your plugin or throws an exception.
void	stop() Stops your plugin or throws an exception.
void	uninstall() Uninstalls your plugin or throws an exception.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

getName

public abstract java.lang.String getName()

Gets the name of the plugin.
People often use Class.getSimpleName() but you are allowed to use your own naming also.

Returns:

plugin name

getAuthor

public abstract java.lang.String getAuthor()

Gets the name of the author.
Usage of String.intern() is recommend if you have multiple plugins under your name.

Returns:

author's name

getCreatedAt

public abstract java.lang.String getCreatedAt()

Gets the creation date of this plugin.

Returns:

creation date

getDescription

public abstract java.lang.String getDescription()

Gets the plugin's description.
Feel free to provide some short details of your plugin.

Returns:

description

getVersion

public abstract int getVersion()

Gets the actual version of this plugin.

Returns:

version

setup

protected abstract void setup(FileInstaller fileInstaller,
                              PluginMigrations migrations,
                              PluginConditions pluginConditions)

Triggered whenever the plugin is being initialized.

Parameters:

fileInstaller - the file installer

migrations - the relevant plugin migrations

pluginConditions - plugin conditions

onInstall

protected abstract void onInstall()

Triggered whenever you install your plugin.

onUninstall

protected abstract void onUninstall()

Triggered whenever you uninstall your plugin.

onMigrate

protected abstract void onMigrate(int from,
                                  int to)

Triggered whenever you migrate your plugin from a version to another.

Parameters:

from - previous release

to - actual release

onStart

protected abstract void onStart()

Triggered whenever your plugin starts.

onStop

protected abstract void onStop()

Triggered whenever your plugin stops.

setState

protected final boolean setState(PluginState currentState,
                                 PluginState newState)

Sets the state of the plugin.

Parameters:

currentState - state from

newState - state to

Returns:

true when the state is changed, otherwise false

getState

public final PluginState getState()

Gets the actual state of the plugin.

Returns:

state

onStateChanged

public void onStateChanged(PluginState oldState,
                           PluginState newState)

An event triggered whenever the plugin's state is changed.

Parameters:

oldState - the previous state

newState - the actual state

init

protected final void init()

A mandatory method that must be triggered in the constructor of your plugin.
Sets up the plugin's environment related things and changed the plugin's state from available to initialized.

start

public final void start()
                 throws PluginException

Starts your plugin or throws an exception.

Throws:

PluginException

stop

public final void stop()
                throws PluginException

Stops your plugin or throws an exception.

Throws:

PluginException

install

public final void install()
                   throws PluginException

Installs your plugin or throws an exception.

Throws:

PluginException

uninstall

public final void uninstall()
                     throws PluginException

Uninstalls your plugin or throws an exception.

Throws:

PluginException

migrate

public final void migrate(int from,
                          int to)
                   throws PluginException

Migrates your plugin from an older version to another.

Parameters:

from - the older version

to - the actual (newer) version

Throws:

PluginException

getConditions

public final PluginConditions getConditions()

Gets the plugin condition holder.

Returns:

conditions

getFileInstaller

public final FileInstaller getFileInstaller()

Gets the file installer.

Returns:

file installer

getInstallers

public java.util.List<IPluginInstaller> getInstallers()

Gets a list of the plugin installers that implements IPluginInstaller.

Returns:

plugin installer list

getMigrations

public final PluginMigrations getMigrations()

Gets the plugin migrations storage.

Returns:

migrations

getAbsolutePath

public final java.nio.file.Path getAbsolutePath(java.lang.String... paths)

Gets the absolute path of the parameter.

Parameters:

paths - path parameters given by the user

Returns:

absolute path

getAbsolutePathString

public final java.lang.String getAbsolutePathString(java.lang.String... paths)

Gets the string version of getAbsolutePath(String...), uses Path.toString().

Parameters:

paths -

Returns:

absolute path

getRelativePath

public final java.nio.file.Path getRelativePath(java.lang.String... paths)

Gets the relative path of the given parameters.

Parameters:

paths - path parameters given by the user

Returns:

relative path

getRelativePathString

public final java.lang.String getRelativePathString(java.lang.String... paths)

Gets the string version of getRelativePath(String...), uses Path.toString().

Parameters:

paths - path given by the user

Returns:

relative path

getPriority

public int getPriority()

Gets plugin's priority.

Returns:

priority

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