A C E F G H I J L P R S

A

AbstractPluginInformation - Class in cf.janga.hook.core

An abstract implementation of PluginInformation, for reuse purposes.

AbstractPluginInformation(String, String, String) - Constructor for class cf.janga.hook.core.AbstractPluginInformation

accept(Extension<T>) - Method in interface cf.janga.hook.core.ExtensionPoint

Asks this extension point to accept this extension, and take care of hooking it to the right spot in the hosting application.

C

canHandle(Extension<T>) - Method in interface cf.janga.hook.core.ExtensionPoint

Checks whether this extension point can handle the provided extension or not.

cf.janga.hook.core - package cf.janga.hook.core

cf.janga.hook.utils - package cf.janga.hook.utils

closeReader(Reader) - Static method in class cf.janga.hook.utils.IOUtils

CoreAPI - Interface in cf.janga.hook.core

The Core API defines which parts of an application are made available to plugins and their extensions.

E

Extension<T extends CoreAPI> - Interface in cf.janga.hook.core

Extensions are the contributions that a plugin brings to a hosting application.

ExtensionPoint<T extends CoreAPI> - Interface in cf.janga.hook.core

Extension points are points in an application which can be extended with extensions provided by plugins.

F

FileConstants - Interface in cf.janga.hook.utils

Placeholder for various constants around files.

G

getCoreAPI() - Method in interface cf.janga.hook.core.HostApplication

Returns the core API the this host application provides to it's extensions.

getDescription() - Method in class cf.janga.hook.core.AbstractPluginInformation

getDescription() - Method in interface cf.janga.hook.core.Extension

Returns the description of this extension.

getDescription() - Method in interface cf.janga.hook.core.PluginInformation

Returns the description of this plugin.

getExtensionPoints() - Method in interface cf.janga.hook.core.HostApplication

Returns all extension points provided by this application.

getExtensions() - Method in interface cf.janga.hook.core.Plugin

Returns all the extensions that this plugin provides.

getFileName() - Method in interface cf.janga.hook.core.PluginFile

Returns the name of the file.

getFilePath() - Method in interface cf.janga.hook.core.PluginFile

Returns the path for this plugin file.

getLoadingError() - Method in interface cf.janga.hook.core.PluginRegistration

Returns an Optional for the error loading the plugin, if any.

getName() - Method in class cf.janga.hook.core.AbstractPluginInformation

getName() - Method in interface cf.janga.hook.core.Extension

Returns the name of this extension.

getName() - Method in interface cf.janga.hook.core.PluginInformation

Returns the name of this plugin.

getPluginClass() - Method in interface cf.janga.hook.core.PluginFile

Returns the class of the plugin wrapped by this file.

getPluginClass() - Method in interface cf.janga.hook.core.PluginRegistration

Returns the plugin class of the plugin under this registration.

getPluginFilePath() - Method in interface cf.janga.hook.core.PluginRegistration

Returns the full path on the disk of the plugin under this registration.

getPluginRegistry() - Method in interface cf.janga.hook.core.PluginPlatform

Returns the plugin registry of this platform.

getPluginRegistry() - Method in class cf.janga.hook.core.SimplePluginPlatform

getRegistrations() - Method in interface cf.janga.hook.core.PluginRegistry

Returns all registrations against this registry.

getSize() - Method in interface cf.janga.hook.core.PluginFile

Returns the size, in bytes, of this plugin file.

getVersion() - Method in class cf.janga.hook.core.AbstractPluginInformation

getVersion() - Method in interface cf.janga.hook.core.CoreAPI

Returns the version of this core API, for checking compatibility among extensions.

getVersion() - Method in interface cf.janga.hook.core.PluginInformation

Returns the version of the plugin.

H

hasExtension(File, String) - Static method in class cf.janga.hook.utils.IOUtils

HostApplication<T extends CoreAPI> - Interface in cf.janga.hook.core

A host application is an application that defines extension points and requires a plugin loader to load and initialize plugins and extensions at runtime.

I

init(T) - Method in interface cf.janga.hook.core.Extension

Initializes this extension.

init() - Method in interface cf.janga.hook.core.PluginPlatform

Initializes this plugin platform.

init() - Method in class cf.janga.hook.core.SimplePluginPlatform

IOUtils - Class in cf.janga.hook.utils

J

JAR_EXTENSION - Static variable in interface cf.janga.hook.utils.FileConstants

L

loadPlugins(String, HostApplication<T>) - Method in interface cf.janga.hook.core.PluginPlatform

Loads plugins found in the path provided.

loadPlugins(String, HostApplication<T>) - Method in class cf.janga.hook.core.SimplePluginPlatform

P

PlatformException - Exception in cf.janga.hook.core

Class of exceptions related to plugin platform.

PlatformException(Throwable) - Constructor for exception cf.janga.hook.core.PlatformException

Creates a new PlatformException having the provided throwable as the cause.

Plugin<T extends CoreAPI> - Interface in cf.janga.hook.core

A piece of software that can contribute with extensions to a host application.

PluginException - Exception in cf.janga.hook.core

Super class of all plugin-related exceptions

PluginException(Exception) - Constructor for exception cf.janga.hook.core.PluginException

Creates a new PluginException.

PluginException(String, Exception) - Constructor for exception cf.janga.hook.core.PluginException

Creates a new PluginException.

PluginException(String) - Constructor for exception cf.janga.hook.core.PluginException

Creates a new PluginException.

PluginFile<T extends CoreAPI> - Interface in cf.janga.hook.core

Represents the package file of a plugin.

PluginInformation - Interface in cf.janga.hook.core

Holds general information about a plugin.

PluginPlatform - Interface in cf.janga.hook.core

A plugin platform is responsible for loading plugins and their extensions and managing their life-cycle.

PluginRegistration - Interface in cf.janga.hook.core

Holds information of a plugin's registration against a plugin platform's PluginRegistry, including loading errors.

PluginRegistry - Interface in cf.janga.hook.core

The plugin registry keeps runtime information about each plugin loaded by its respective PluginPlatform.

R

register(PluginRegistration) - Method in interface cf.janga.hook.core.PluginRegistry

Adds a new plugin registration to the registry.

S

SimplePluginPlatform - Class in cf.janga.hook.core

A simple implementation of the PluginPlatform interface.

SimplePluginPlatform() - Constructor for class cf.janga.hook.core.SimplePluginPlatform

stop() - Method in interface cf.janga.hook.core.PluginPlatform

Stops this plugin platform.

stop() - Method in class cf.janga.hook.core.SimplePluginPlatform

A C E F G H I J L P R S