@Retention(value=RUNTIME)
@Target(value={METHOD,TYPE})
public @interface Plugin
Modifier and Type | Required Element and Description |
---|---|
java.lang.String |
name
Returns the name identifying this plugin in a human readable way.
|
java.lang.String[] |
parameterLabels
Returns the labels of the parameters for this plugin.
|
java.lang.String[] |
returnLabels
Returns an Array of strings, such that each String is an initial label
for a returned object.
|
java.lang.Class<?>[] |
returnTypes
Returns an Array of Class objects, such that each class object represents
the type of the returned object at that index, i.e.
|
Modifier and Type | Optional Element and Description |
---|---|
PluginCategory[] |
categories
Categories define the 'type' of functionality the plugin provides.
|
boolean |
handlesCancel
Whether this plugin handles cancel itself.
|
java.lang.String |
help
Returns the help / description for this plugin.
|
java.lang.String[] |
keywords
Keywords / tags for the plugin (extra description)
|
PluginLevel |
level
Indication of level for plug-in.
|
int |
mostSignificantResult
Returns the index + 1 in the result array of the most significant result
for this plugin, i.e.
|
PluginQuality |
quality
Indication of quality for plug-in.
|
boolean |
userAccessible
Signals the framework to make this plugin user-accessible.
|
public abstract java.lang.String name
public abstract java.lang.String[] returnLabels
public abstract java.lang.Class<?>[] returnTypes
public abstract java.lang.String[] parameterLabels
public abstract java.lang.String help
public abstract boolean userAccessible
public abstract int mostSignificantResult
public abstract boolean handlesCancel
public abstract PluginCategory[] categories
public abstract java.lang.String[] keywords
public abstract PluginQuality quality
public abstract PluginLevel level