Package com.thewinterframework.plugin

Interface WinterPlugin

All Superinterfaces:
com.google.inject.Module, net.kyori.adventure.key.Namespaced
public interface WinterPlugin extends com.google.inject.Module, net.kyori.adventure.key.Namespaced
This class should be extended by any plugin that is used by the WinterBoot annotation.

  • Method Details

    • configure

      default void configure(com.google.inject.Binder binder)
      Specified by:
      configure in interface com.google.inject.Module

    • onPluginLoad

      default void onPluginLoad()
      Called when the plugin is loaded
      NOTE: Plugin injections is not available at this point

    • onPluginEnable

      default void onPluginEnable()
      Called when the plugin is enabled
      NOTE: Plugin injections is available at this point

    • onPluginDisable

      default void onPluginDisable()
      Called when the plugin is disabled
      NOTE: Plugin injections is available at this point

    • getInjector

      com.google.inject.Injector getInjector()
      Returns the plugin injector
      Returns:
      the plugin injector

    • getSLF4JLogger

      org.slf4j.Logger getSLF4JLogger()
      Returns the plugin logger
      Returns:
      the plugin logger

    • getModuleManager

      PluginModuleManager getModuleManager()
      Returns the plugin module manager
      Returns:
      the plugin module manager

    • getExpressionResolver

      ExpressionResolver getExpressionResolver()
      Returns the annotation expression resolver
      Returns:
      the annotation expression resolver

    • setExpressionResolver

      void setExpressionResolver(ExpressionResolver resolver)
      Sets the annotation expression resolver
      Parameters:
      resolver - the annotation expression resolver

    • getZoneId

      default ZoneId getZoneId()
      Returns the plugin zone id
      Returns:
      the plugin zone id

    • getScheduler

      PluginScheduler getScheduler()
      Returns the task scheduler
      Returns:
      the task scheduler

    • getPlatformManager

      PlatformPluginManager getPlatformManager()
      Returns the platform plugin manager
      Returns:
      the platform plugin manager