Package de.iip_ecosphere.platform.support.plugins

Class Plugin<T>

java.lang.Object

de.iip_ecosphere.platform.support.plugins.Plugin<T>

Type Parameters:

T - the type of the implementing class

Direct Known Subclasses:

SingletonPlugin

public class Plugin<T>
extends Object

Represents a plugin.

Author:

Holger Eichelberger, SSE

Field Summary

Fields

Modifier and Type	Field	Description
private Function<Plugin<T>,T>	creator
private String	id
private List<String>	ids
private File	installDir
private Class<T>	instanceCls

Constructor Summary

Constructors

Constructor	Description
Plugin(String id, List<String> ids, Class<T> instanceCls, Function<Plugin<T>,T> creator, File installDir)	Creates a plugin instance.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Cleans up this plugin.
List<String>	getAllIds()	Returns the primary and all secondary ids.
List<String>	getFurtherIds()	Returns further ids.
String	getId()	Returns the unique/primary plugin id.
File	getInstallDir()	Returns the installation directory.
T	getInstance()	Returns the implementing class.
Class<T>	getInstanceClass()	Returns the type of the implementing class.

Methods inherited from class java.lang.Object

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

Field Details

id

private String id

ids

private List<String> ids

instanceCls

private Class<T> instanceCls

creator

private Function<Plugin<T>,T> creator

installDir

private File installDir

Constructor Details

Plugin

public Plugin(String id,
 List<String> ids,
 Class<T> instanceCls,
 Function<Plugin<T>,T> creator,
 File installDir)

Creates a plugin instance.

Parameters:

id - the primary plugin id

ids - further (optional) ids, may be empty or null

instanceCls - the instance class

creator - the creator supplier

installDir - the installation directory, may be null

Method Details

getId

public String getId()

Returns the unique/primary plugin id. Shall comply with the corresponding PluginDescriptor.

Returns:

the id

getFurtherIds

public List<String> getFurtherIds()

Returns further ids. Shall comply with the corresponding PluginDescriptor.

Returns:

the further ids, may be null, empty, unmodifiable

getAllIds

public List<String> getAllIds()

Returns the primary and all secondary ids.

Returns:

the ids

getInstanceClass

public Class<T> getInstanceClass()

Returns the type of the implementing class.

Returns:

the implementing class type

getInstance

public T getInstance()

Returns the implementing class.

Returns:

the implementing class

cleanup

public void cleanup()

Cleans up this plugin.

getInstallDir

public File getInstallDir()

Returns the installation directory.

Returns:

the directory, may be null