Package net.storm.api.plugins

Annotation Type PluginDescriptor

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

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name  

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String configName
      Internal name used in the config.
      java.lang.String[] conflicts
      A list of plugin names that are mutually exclusive with this plugin.
      java.lang.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  
      java.lang.String[] tags
      A list of plugin keywords, used (together with the name) when searching for plugins.

    • Element Detail

      • name

        java.lang.String name

      • configName

        java.lang.String configName
        Internal name used in the config.
        Default:
        ""

      • description

        java.lang.String description
        A short, one-line summary of the plugin.
        Default:
        ""

      • tags

        java.lang.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

        java.lang.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