A C D E F G H I L M O P R S T U V

A

AbstractPlugin - Class in com.github.unafraid.plugins

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 AbstractPlugin.init() in the constructor of your plugin.

AbstractPlugin() - Constructor for class com.github.unafraid.plugins.AbstractPlugin

addCondition(ConditionType, IPluginCondition) - Method in class com.github.unafraid.plugins.conditions.PluginConditions

Registers a condition into this storage class if it isn't there already.

addFile(String, String) - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

Registers a file into this installer.

addFolder(String, String) - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

Registers a folder into this installer.

addMigration(IPluginMigration) - Method in class com.github.unafraid.plugins.migrations.PluginMigrations

Registers a migration into this storage class.

C

ClassPathUtil - Class in com.github.unafraid.plugins.util

A simple utility class to handle getting classes/packages.

com.github.unafraid.plugins - package com.github.unafraid.plugins

com.github.unafraid.plugins.conditions - package com.github.unafraid.plugins.conditions

com.github.unafraid.plugins.exceptions - package com.github.unafraid.plugins.exceptions

com.github.unafraid.plugins.installers - package com.github.unafraid.plugins.installers

com.github.unafraid.plugins.installers.file - package com.github.unafraid.plugins.installers.file

com.github.unafraid.plugins.migrations - package com.github.unafraid.plugins.migrations

com.github.unafraid.plugins.util - package com.github.unafraid.plugins.util

ConditionResult - Class in com.github.unafraid.plugins.conditions

The condition result class.

ConditionResult(boolean, String) - Constructor for class com.github.unafraid.plugins.conditions.ConditionResult

Constructs a new condition result.

ConditionType - Enum in com.github.unafraid.plugins.conditions

THe possible condition types listed below.

D

describe() - Method in class com.github.unafraid.plugins.conditions.ConditionResult

Describes the condition.

E

equals(Object) - Method in class com.github.unafraid.plugins.AbstractPlugin

equals(Object) - Method in class com.github.unafraid.plugins.conditions.ConditionResult

equals(Object) - Method in class com.github.unafraid.plugins.conditions.PluginConditions

equals(Object) - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

equals(Object) - Method in class com.github.unafraid.plugins.installers.file.PluginFile

equals(Object) - Method in class com.github.unafraid.plugins.migrations.PluginMigrations

F

FileInstaller - Class in com.github.unafraid.plugins.installers.file

A simple file installer that handles types of PluginFile holder class.

FileInstaller() - Constructor for class com.github.unafraid.plugins.installers.file.FileInstaller

G

getAbsolutePath(String...) - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the absolute path of the parameter.

getAbsolutePathString(String...) - Method in class com.github.unafraid.plugins.AbstractPlugin

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

getAllClassesExtending(Class<T>) - Static method in class com.github.unafraid.plugins.util.ClassPathUtil

Gets all classes extending the given target class.

getAllClassesExtending(String, Class<T>) - Static method in class com.github.unafraid.plugins.util.ClassPathUtil

Gets all classes extending the given target class.

getAllMethodsAnnotatedWith(Class<? extends Annotation>) - Static method in class com.github.unafraid.plugins.util.ClassPathUtil

Gets all methods annotated with the specified annotation.

getAllMethodsAnnotatedWith(String, Class<? extends Annotation>) - Static method in class com.github.unafraid.plugins.util.ClassPathUtil

Gets all methods inside the package annotated with the specified annotation.

getAllPlugins() - Method in class com.github.unafraid.plugins.PluginRepository

Gets a Map view of all plugins.

getAuthor() - Method in class com.github.unafraid.plugins.AbstractPlugin

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

getAvailablePlugin(String) - Method in class com.github.unafraid.plugins.PluginRepository

Gets an available plugin by its name.

getAvailablePlugins() - Method in class com.github.unafraid.plugins.PluginRepository

Gets a Stream view of available plugins.

getClassLoader(T) - Method in class com.github.unafraid.plugins.PluginRepository

Gets a class loader by the plugin.

getConditions() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the plugin condition holder.

getConditions(ConditionType) - Method in class com.github.unafraid.plugins.conditions.PluginConditions

Gets condition by the type it is registered.

getCreatedAt() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the creation date of this plugin.

getDescription() - Method in class com.github.unafraid.plugins.AbstractPlugin

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

getDescription() - Method in interface com.github.unafraid.plugins.migrations.IPluginMigration

Gets the description of this migration.
In short: the reason of change, what happened, etc.

getDestination() - Method in class com.github.unafraid.plugins.installers.file.PluginFile

Gets the name of the destination file.

getDirectories() - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

Gets the registered directories inside this installer.

getFileInstaller() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the file installer.

getFiles() - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

Gets the registered files inside this installer.

getInformation() - Method in interface com.github.unafraid.plugins.conditions.IPluginCondition

Gets the information related to this condition.

getInstallers() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets a list of the plugin installers that implements IPluginInstaller.

getInstanceOfExtending(Class<T>) - Static method in class com.github.unafraid.plugins.util.ClassPathUtil

Gets a Class.newInstance() of the first class extending the given target class.

getMigrations() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the plugin migrations storage.

getMigrations() - Method in class com.github.unafraid.plugins.migrations.PluginMigrations

Gets a Set view of the migrations.

getName() - Method in class com.github.unafraid.plugins.AbstractPlugin

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

getPriority() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets plugin's priority.

getRelativePath(String...) - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the relative path of the given parameters.

getRelativePathString(String...) - Method in class com.github.unafraid.plugins.AbstractPlugin

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

getSource() - Method in class com.github.unafraid.plugins.installers.file.PluginFile

Gets name of the original file.

getState() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the actual state of the plugin.

getTargetVersion() - Method in interface com.github.unafraid.plugins.migrations.IPluginMigration

The target version where migrations is applicable.

getVersion() - Method in class com.github.unafraid.plugins.AbstractPlugin

Gets the actual version of this plugin.

H

hashCode() - Method in class com.github.unafraid.plugins.AbstractPlugin

hashCode() - Method in class com.github.unafraid.plugins.conditions.ConditionResult

hashCode() - Method in class com.github.unafraid.plugins.conditions.PluginConditions

hashCode() - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

hashCode() - Method in class com.github.unafraid.plugins.installers.file.PluginFile

hashCode() - Method in class com.github.unafraid.plugins.migrations.PluginMigrations

I

init() - Method in class com.github.unafraid.plugins.AbstractPlugin

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.

install() - Method in class com.github.unafraid.plugins.AbstractPlugin

Installs your plugin or throws an exception.

install(AbstractPlugin) - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

install(AbstractPlugin) - Method in interface com.github.unafraid.plugins.installers.IPluginInstaller

Triggered whenever the plugin is being installed.

IPluginCondition - Interface in com.github.unafraid.plugins.conditions

The interface that is used to create a condition.

IPluginInstaller - Interface in com.github.unafraid.plugins.installers

A simple interface to provide a possibility to register several types of custom installers.

IPluginMigration - Interface in com.github.unafraid.plugins.migrations

An interface to be used to create plugin migrations.

isSuccess() - Method in class com.github.unafraid.plugins.conditions.ConditionResult

Whether condition is successful or not.

L

LOGGER - Static variable in class com.github.unafraid.plugins.installers.file.FileInstaller

M

migrate(int, int) - Method in class com.github.unafraid.plugins.AbstractPlugin

Migrates your plugin from an older version to another.

migrate(AbstractPlugin) - Method in interface com.github.unafraid.plugins.migrations.IPluginMigration

Triggered whenever the plugin is being migrated.

migrate(int, int, AbstractPlugin) - Method in class com.github.unafraid.plugins.migrations.PluginMigrations

A method to start all possible applicable migrations.

O

onInstall() - Method in class com.github.unafraid.plugins.AbstractPlugin

Triggered whenever you install your plugin.

onMigrate(int, int) - Method in class com.github.unafraid.plugins.AbstractPlugin

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

onStart() - Method in class com.github.unafraid.plugins.AbstractPlugin

Triggered whenever your plugin starts.

onStateChanged(PluginState, PluginState) - Method in class com.github.unafraid.plugins.AbstractPlugin

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

onStop() - Method in class com.github.unafraid.plugins.AbstractPlugin

Triggered whenever your plugin stops.

onUninstall() - Method in class com.github.unafraid.plugins.AbstractPlugin

Triggered whenever you uninstall your plugin.

P

PluginConditions - Class in com.github.unafraid.plugins.conditions

Stores the conditions.

PluginConditions() - Constructor for class com.github.unafraid.plugins.conditions.PluginConditions

PluginException - Exception in com.github.unafraid.plugins.exceptions

An exception triggered by this plugin API whenever a plugin event is failed.

PluginException(String) - Constructor for exception com.github.unafraid.plugins.exceptions.PluginException

Constructs the exception thrown by a failed plugin event.

PluginException(Throwable) - Constructor for exception com.github.unafraid.plugins.exceptions.PluginException

Constructs the exception thrown by a failed plugin event.

PluginFile - Class in com.github.unafraid.plugins.installers.file

A simple holder class that represents a plugin file.

PluginFile(String, String) - Constructor for class com.github.unafraid.plugins.installers.file.PluginFile

Constructs the plugin file.

PluginMigrations - Class in com.github.unafraid.plugins.migrations

A class that stores a set of migrations.
Migration happens whenever you upgrade your plugin from an older version to a newer.

PluginMigrations() - Constructor for class com.github.unafraid.plugins.migrations.PluginMigrations

PluginRepository<T extends AbstractPlugin> - Class in com.github.unafraid.plugins

This is the class that scans for available plugins.
You can assume that it is the plugin manager.

PluginRepository() - Constructor for class com.github.unafraid.plugins.PluginRepository

PluginRuntimeException - Exception in com.github.unafraid.plugins.exceptions

A runtime exception version of PluginException.

PluginRuntimeException(String) - Constructor for exception com.github.unafraid.plugins.exceptions.PluginRuntimeException

Constructs the exception thrown by a failed plugin event.

PluginRuntimeException(Throwable) - Constructor for exception com.github.unafraid.plugins.exceptions.PluginRuntimeException

Constructs the exception thrown by a failed plugin event.

PluginState - Enum in com.github.unafraid.plugins

A simple enum that contains the possible plugin states this API/you might set.

R

run() - Method in interface com.github.unafraid.plugins.util.ThrowableRunnable

runOrThrow() - Method in interface com.github.unafraid.plugins.util.ThrowableRunnable

S

scan(Class<T>) - Method in class com.github.unafraid.plugins.PluginRepository

This method scans your classpath for the available plugins that can be initialized.
If you aren't using IDE, you may drop your plugin JARs into "plugins" directory.

setState(PluginState, PluginState) - Method in class com.github.unafraid.plugins.AbstractPlugin

Sets the state of the plugin.

setup(FileInstaller, PluginMigrations, PluginConditions) - Method in class com.github.unafraid.plugins.AbstractPlugin

Triggered whenever the plugin is being initialized.

start() - Method in class com.github.unafraid.plugins.AbstractPlugin

Starts your plugin or throws an exception.

startAll() - Method in class com.github.unafraid.plugins.PluginRepository

Starts all initialized plugins and setting them to installed.

stop() - Method in class com.github.unafraid.plugins.AbstractPlugin

Stops your plugin or throws an exception.

stopAll() - Method in class com.github.unafraid.plugins.PluginRepository

Stops all plugins.

T

test(AbstractPlugin) - Method in interface com.github.unafraid.plugins.conditions.IPluginCondition

Fires the condition.

testConditions(ConditionType, AbstractPlugin) - Method in class com.github.unafraid.plugins.conditions.PluginConditions

Fires conditions by type on the plugin.

ThrowableRunnable - Interface in com.github.unafraid.plugins.util

A simple wrapper class to invoke PluginRuntimeException in case an exception is caught.

toString() - Method in class com.github.unafraid.plugins.installers.file.PluginFile

U

uninstall() - Method in class com.github.unafraid.plugins.AbstractPlugin

Uninstalls your plugin or throws an exception.

uninstall(AbstractPlugin) - Method in class com.github.unafraid.plugins.installers.file.FileInstaller

uninstall(AbstractPlugin) - Method in interface com.github.unafraid.plugins.installers.IPluginInstaller

Triggered whenever the plugin is being uninstalled.

V

valueOf(String) - Static method in enum com.github.unafraid.plugins.conditions.ConditionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.unafraid.plugins.PluginState

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.unafraid.plugins.conditions.ConditionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.unafraid.plugins.PluginState

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I L M O P R S T U V