io.cdap.cdap.api.plugin

Class Plugin

java.lang.Object

io.cdap.cdap.api.plugin.Plugin

public final class Plugin
extends Object

A container class for holding plugin information.

Constructor Summary

Constructors

Constructor and Description
Plugin(Iterable<ArtifactId> parents, ArtifactId artifactId, PluginClass pluginClass, PluginProperties properties) Create a Plugin

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ArtifactId	getArtifactId()
List<ArtifactId>	getParents()
PluginClass	getPluginClass()
PluginProperties	getProperties() Returns the set of properties available when the plugin was created.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin(Iterable<ArtifactId> parents,
              ArtifactId artifactId,
              PluginClass pluginClass,
              PluginProperties properties)

Create a Plugin

Parameters:

parents - iterable of parent plugins. The first parent must be the direct parent of this plugin, and each subsequent item in the iterable must be the direct parent of the item before it

artifactId - the artifact for this plugin

pluginClass - information about the plugin class

properties - properties of the plugin

Method Detail

getParents

public List<ArtifactId> getParents()

Returns:

the artifact parent chain. Every artifact in the list is the parent of the artifact behind it. This list does not contain the plugin's artifact, which means it will be an empty list if the plugin's parent is a program and not another plugin.

getArtifactId

public ArtifactId getArtifactId()

Returns:

artifact id of the plugin

getPluginClass

public PluginClass getPluginClass()

Returns:

PluginClass

getProperties

public PluginProperties getProperties()

Returns the set of properties available when the plugin was created.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object