io.cdap.cdap.api.plugin

Class PluginClass

java.lang.Object

io.cdap.cdap.api.plugin.PluginClass

@Beta
public class PluginClass
extends Object

Contains information about a plugin class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginClass.Builder A builder to create PluginClass instance.

Constructor Summary

Constructors

Constructor and Description
PluginClass(String type, String name, String className, String configfieldName, Map<String,PluginPropertyField> properties, Requirements requirements, String description) Deprecated. use PluginClass.Builder to create the object
PluginClass(String type, String name, String description, String className, String configfieldName, Map<String,PluginPropertyField> properties) Deprecated. use PluginClass.Builder to create the object

Method Summary

Modifier and Type	Method and Description
static PluginClass.Builder	builder()
boolean	equals(Object o)
String	getCategory() Returns the category of the plugin.
String	getClassName() Returns the fully qualified class name of the plugin.
String	getConfigFieldName() Returns the name of the field that extends from PluginConfig in the plugin class.
String	getDescription() Returns description of the plugin.
String	getName() Returns name of the plugin.
Map<String,PluginPropertyField>	getProperties() Returns a map from config property name to PluginPropertyField that are supported by the plugin class.
Requirements	getRequirements()
String	getType() Returns the type name of the plugin.
int	hashCode()
String	toString()
void	validate() Validates the PluginClass

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginClass

@Deprecated
public PluginClass(String type,
                               String name,
                               String className,
                               @Nullable
                               String configfieldName,
                               Map<String,PluginPropertyField> properties,
                               Requirements requirements,
                               String description)

Deprecated. use PluginClass.Builder to create the object

PluginClass

@Deprecated
public PluginClass(String type,
                               String name,
                               String description,
                               String className,
                               @Nullable
                               String configfieldName,
                               Map<String,PluginPropertyField> properties)

Deprecated. use PluginClass.Builder to create the object

Method Detail

builder

public static PluginClass.Builder builder()

validate

public void validate()

Validates the PluginClass

Throws:

IllegalArgumentException - if any of the required fields are invalid

getType

public String getType()

Returns the type name of the plugin.

getName

public String getName()

Returns name of the plugin.

getCategory

@Nullable
public String getCategory()

Returns the category of the plugin. If a plugin does not belong to any category, null will be returned.

getDescription

public String getDescription()

Returns description of the plugin.

getClassName

public String getClassName()

Returns the fully qualified class name of the plugin.

getConfigFieldName

@Nullable
public String getConfigFieldName()

Returns the name of the field that extends from PluginConfig in the plugin class. If no such field, null will be returned.

getProperties

public Map<String,PluginPropertyField> getProperties()

Returns a map from config property name to PluginPropertyField that are supported by the plugin class.

getRequirements

public Requirements getRequirements()

Returns:

the Requirements which represents the requirements of the plugin

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