Package org.deltafi.common.types

Class Plugin

java.lang.Object

org.deltafi.common.types.Plugin

public class Plugin
extends java.lang.Object

A Plugin is a collection of actions. It may depend on other Plugins.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Plugin.Builder

Constructor Summary

Constructors

Constructor	Description
Plugin()
Plugin(PluginCoordinates pluginCoordinates, java.lang.String displayName, java.lang.String description, java.lang.String actionKitVersion, java.util.List<ActionDescriptor> actions, java.util.List<PluginCoordinates> dependencies, java.util.List<PropertySet> propertySets, java.util.List<Variable> variables)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getActionKitVersion()	The action kit version
java.util.List<ActionDescriptor>	getActions()	The actions included
java.util.List<PluginCoordinates>	getDependencies()	The plugin coordinates of required plugins
java.lang.String	getDescription()	A description of the functionality provided
java.lang.String	getDisplayName()	A user-friendly name
PluginCoordinates	getPluginCoordinates()	The identifying coordinates
java.util.List<PropertySet>	getPropertySets()	The properties required
java.util.List<Variable>	getVariables()	Variables associated with this plugin
int	hashCode()
static Plugin.Builder	newBuilder()
void	setActionKitVersion(java.lang.String actionKitVersion)
void	setActions(java.util.List<ActionDescriptor> actions)
void	setDependencies(java.util.List<PluginCoordinates> dependencies)
void	setDescription(java.lang.String description)
void	setDisplayName(java.lang.String displayName)
void	setPluginCoordinates(PluginCoordinates pluginCoordinates)
void	setPropertySets(java.util.List<PropertySet> propertySets)
void	setVariables(java.util.List<Variable> variables)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin()

Plugin

public Plugin(PluginCoordinates pluginCoordinates,
              java.lang.String displayName,
              java.lang.String description,
              java.lang.String actionKitVersion,
              java.util.List<ActionDescriptor> actions,
              java.util.List<PluginCoordinates> dependencies,
              java.util.List<PropertySet> propertySets,
              java.util.List<Variable> variables)

Method Detail

getPluginCoordinates

public PluginCoordinates getPluginCoordinates()

The identifying coordinates

setPluginCoordinates

public void setPluginCoordinates(PluginCoordinates pluginCoordinates)

getDisplayName

public java.lang.String getDisplayName()

A user-friendly name

setDisplayName

public void setDisplayName(java.lang.String displayName)

getDescription

public java.lang.String getDescription()

A description of the functionality provided

setDescription

public void setDescription(java.lang.String description)

getActionKitVersion

public java.lang.String getActionKitVersion()

The action kit version

setActionKitVersion

public void setActionKitVersion(java.lang.String actionKitVersion)

getActions

public java.util.List<ActionDescriptor> getActions()

The actions included

setActions

public void setActions(java.util.List<ActionDescriptor> actions)

getDependencies

public java.util.List<PluginCoordinates> getDependencies()

The plugin coordinates of required plugins

setDependencies

public void setDependencies(java.util.List<PluginCoordinates> dependencies)

getPropertySets

public java.util.List<PropertySet> getPropertySets()

The properties required

setPropertySets

public void setPropertySets(java.util.List<PropertySet> propertySets)

getVariables

public java.util.List<Variable> getVariables()

Variables associated with this plugin

setVariables

public void setVariables(java.util.List<Variable> variables)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

newBuilder

public static Plugin.Builder newBuilder()