Package nz.org.riskscape.engine.plugin

Class BuiltInPluginDescriptor

java.lang.Object

nz.org.riskscape.engine.plugin.BuiltInPluginDescriptor

All Implemented Interfaces:

nz.org.riskscape.engine.plugin.PluginDescriptor

public class BuiltInPluginDescriptor
extends Object
implements nz.org.riskscape.engine.plugin.PluginDescriptor

A plugin descriptor for code that wasn't dynamically loaded (and can also be used in some testing scenarios)

Constructor Summary

Constructors

Constructor	Description
BuiltInPluginDescriptor(String pluginId, nz.org.riskscape.engine.BuildInfo buildInfo, Class<? extends nz.org.riskscape.engine.plugin.Plugin> pluginClass, Path sourcePath)	Creates a new BuiltInPluginDescriptor instance.

Method Summary

Modifier and Type	Method	Description
void	addDependency(nz.org.riskscape.engine.plugin.PluginDescriptor dependencyDescriptor)
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ClassLoader	getI18nClassLoader()
String	getPluginClassName()
Set<String>	getPluginDependencies()
String	getPluginId()
Path	getSourcePath()	The location where this plugin and its resources can be accessed.
String	getVersion()
int	hashCode()
boolean	hasPluginDependencies()
nz.org.riskscape.engine.plugin.Plugin	newPluginInstance()
static <T extends nz.org.riskscape.engine.plugin.Plugin> T	testPlugin(Class<T> pluginClass)	Build a plugin for use in tests, setting the source path to be the process working directory.
static <T extends nz.org.riskscape.engine.plugin.Plugin> T	testPlugin(Class<T> pluginClass, Path sourcePath)	Build a plugin for use in tests
static <T extends nz.org.riskscape.engine.plugin.Plugin> T	testPlugin(String pluginId, Class<T> pluginClass, Path sourcePath)	Build a plugin for use in tests
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BuiltInPluginDescriptor

public BuiltInPluginDescriptor(String pluginId,
 nz.org.riskscape.engine.BuildInfo buildInfo,
 Class<? extends nz.org.riskscape.engine.plugin.Plugin> pluginClass,
 Path sourcePath)

Creates a new BuiltInPluginDescriptor instance.

Parameters:

pluginId -

buildInfo -

pluginClass -

sourcePath - The location where this plugin and its resources can be accessed. Currently only used by the cpython plugin to find the python code it needs.

Method Details

testPlugin

public static <T extends nz.org.riskscape.engine.plugin.Plugin>
T testPlugin(Class<T> pluginClass)

Build a plugin for use in tests, setting the source path to be the process working directory.

testPlugin

public static <T extends nz.org.riskscape.engine.plugin.Plugin>
T testPlugin(String pluginId,
 Class<T> pluginClass,
 Path sourcePath)

Build a plugin for use in tests

testPlugin

public static <T extends nz.org.riskscape.engine.plugin.Plugin>
T testPlugin(Class<T> pluginClass,
 Path sourcePath)

Build a plugin for use in tests

getI18nClassLoader

public ClassLoader getI18nClassLoader()

Specified by:

getI18nClassLoader in interface nz.org.riskscape.engine.plugin.PluginDescriptor

newPluginInstance

public nz.org.riskscape.engine.plugin.Plugin newPluginInstance()

Specified by:

newPluginInstance in interface nz.org.riskscape.engine.plugin.PluginDescriptor

hasPluginDependencies

public boolean hasPluginDependencies()

Specified by:

hasPluginDependencies in interface nz.org.riskscape.engine.plugin.PluginDescriptor

getPluginDependencies

public Set<String> getPluginDependencies()

Specified by:

getPluginDependencies in interface nz.org.riskscape.engine.plugin.PluginDescriptor

addDependency

public void addDependency(nz.org.riskscape.engine.plugin.PluginDescriptor dependencyDescriptor)

Specified by:

addDependency in interface nz.org.riskscape.engine.plugin.PluginDescriptor

getPluginClassName

public String getPluginClassName()

Specified by:

getPluginClassName in interface nz.org.riskscape.engine.plugin.PluginDescriptor

getVersion

public String getVersion()

Specified by:

getVersion in interface nz.org.riskscape.engine.plugin.PluginDescriptor

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getPluginId

public String getPluginId()

Specified by:

getPluginId in interface nz.org.riskscape.engine.plugin.PluginDescriptor

getSourcePath

public Path getSourcePath()

The location where this plugin and its resources can be accessed. Currently only used by the cpython plugin to find the python code it needs.

Specified by:

getSourcePath in interface nz.org.riskscape.engine.plugin.PluginDescriptor