Package net.storm.api.plugins

Annotation Interface PluginDescriptor

@Retention(RUNTIME)
@Target(TYPE)
@Documented
public @interface PluginDescriptor

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	configName	Internal name used in the config.
String[]	conflicts	A list of plugin names that are mutually exclusive with this plugin.
String	description	A short, one-line summary of the plugin.
boolean	enabledByDefault	Only used by core plugins, will not work for SDN/External plugins.
boolean	hidden
String[]	tags	A list of plugin keywords, used (together with the name) when searching for plugins.

Element Details

name

String name

configName

String configName

Internal name used in the config.

Default:

""

description

String description

A short, one-line summary of the plugin.

Default:

""

tags

String[] tags

A list of plugin keywords, used (together with the name) when searching for plugins. Each tag should not contain any spaces, and should be fully lowercase.

Default:

{}

conflicts

String[] conflicts

A list of plugin names that are mutually exclusive with this plugin. Any plugins with a name or conflicts value that matches this will be disabled when this plugin is started

Default:

{}

hidden

boolean hidden

Default:

false

enabledByDefault

boolean enabledByDefault

Only used by core plugins, will not work for SDN/External plugins.

Default:

false