Package com.ultikits.ultitools.annotations

Annotation Interface PluginDependency

@Retention(RUNTIME) @Target(TYPE) public @interface PluginDependency
Declares plugin dependencies for UltiTools plugins. Used to ensure plugins are loaded in the correct order.

Only depends() refuses a module for a missing target: a module is not loaded when a depends target is missing, and that refusal propagates to every module that transitively depends on it. softDepends() and loadBefore() only order modules that are present: a name that is not installed is ignored, and a module that names a module refused for a missing dependency there still loads. A dependency cycle is different: the cycle members and every module that must load after one of them - through any of these attributes or a plugin.yml loadAfter entry - cannot be ordered and are not loaded. 


 @UltiToolsModule(scanBasePackages = {"com.example.myplugin"})
 @PluginDependency(
     depends = {"CorePlugin", "UtilsPlugin"},
     softDepends = {"OptionalPlugin"}
 )
 public class MyPlugin extends UltiToolsPlugin {
     // ...
 }
Since:
6.2.0
Author:
wisdomme

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    depends
    Required plugin dependencies.
    String[]
    loadBefore
    Plugins that should be loaded after this plugin.
    String[]
    softDepends
    Optional plugin dependencies (soft dependencies).

  • Element Details

    • depends

      String[] depends
      Required plugin dependencies. The plugin will fail to load if any of these dependencies are missing or are themselves refused, and every plugin that transitively depends on it is refused with it. This is the only attribute along which a missing-dependency refusal propagates.
      Returns:
      array of required plugin names
      Default:
      {}

    • softDepends

      String[] softDepends
      Optional plugin dependencies (soft dependencies). The plugin will still load even if these dependencies are missing, or are refused for a missing dependency of their own, but it will be loaded after them if they load. Ordering only; see the type-level note on cycles.
      Returns:
      array of optional plugin names
      Default:
      {}

    • loadBefore

      String[] loadBefore
      Plugins that should be loaded after this plugin. Ordering only: it applies to named plugins that are present, a name that is not installed is ignored, and refusing this plugin for a missing dependency does not refuse the named plugins. It does not make the named plugins depend on this one; see the type-level note on cycles.
      Returns:
      array of plugin names that should load after
      Default:
      {}