com.tplan.robot.plugin

Class PluginDependency

java.lang.Object

com.tplan.robot.plugin.PluginDependency

public class PluginDependency
extends Object

Dependency is a class which describes dependency of a plugin (called "dependent plugin") on another plugin ("dependency plugin"). When a plugin is being installed, the Plugin Manager invokes its Plugin.checkDependencies(com.tplan.robot.plugin.PluginManager) method. If one or more of the required dependencies are not installed, the plugin is supposed to construct dependency criteria represented by instances of this class and throw them through a DependencyMissingException back to the Plugin Manager.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
PluginDependency(Plugin dependentPlugin, String dependencyCode, Class dependencyInterface, String dependencyUniqueId, int[] dependencyVersion) Constructor with arguments referring to attributes of a plugin which is required as a dependency.

Method Summary

Modifier and Type	Method and Description
String	getDependencyCode() Get code of the dependency plugin.
Class	getDependencyInterface() Get the exposed functional interface implemented by the dependency plugin.
String	getDependencyUniqueId() Get required unique ID of the dependency plugin.
int[]	getDependencyVersion() Get required version of the dependency plugin.
Plugin	getDependentPlugin() Get the dependent plugin (source of this dependency).

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDependency

public PluginDependency(Plugin dependentPlugin,
                        String dependencyCode,
                        Class dependencyInterface,
                        String dependencyUniqueId,
                        int[] dependencyVersion)

Constructor with arguments referring to attributes of a plugin which is required as a dependency.

Parameters:

dependentPlugin - source of the dependency, a plugin which is depending on certain other plugin functionality described by the other parameters.

dependencyCode - dependency plugin code. This parameter must not be null.

dependencyInterface - dependency plugin interface. This parameter must not be null.

dependencyUniqueId - unique ID desired unique ID of the dependency plugin (optional). It allows to specify dependency on a plugin from particular provider (vendor). If null is provided, it is taken as that the dependent plugin can do with a dependency one from any provider.

dependencyVersion - desired version of the dependency plugin (optional). If null is provided, it is taken as that the dependent plugin can do with any version of the dependency one.

Method Detail

getDependencyCode

public String getDependencyCode()

Get code of the dependency plugin.

Returns:

code of the dependency plugin. As this parameter is mandatory, the method never returns null.

getDependencyUniqueId

public String getDependencyUniqueId()

Get required unique ID of the dependency plugin.

Returns:

unique ID of the dependency plugin. As this parameter is optional, the method may return null.

getDependencyVersion

public int[] getDependencyVersion()

Get required version of the dependency plugin.

Returns:

version of the dependency plugin. As this parameter is optional, the method may return null.

getDependentPlugin

public Plugin getDependentPlugin()

Get the dependent plugin (source of this dependency).

Returns:

dependent plugin.

getDependencyInterface

public Class getDependencyInterface()

Get the exposed functional interface implemented by the dependency plugin.

Returns:

functional interface of the dependency plugin. As this parameter is mandatory, the method never returns null.