Package cc.carm.plugin.minesql.api

Interface SQLRegistry

  • public interface SQLRegistry
    入口类

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default @Nullable cc.carm.lib.easysql.api.SQLManager get()
      获取原生注册的首个 SQLManager 实例
      default @Nullable cc.carm.lib.easysql.api.SQLManager get​(@Nullable java.lang.String name)
      获取原生注册的指定名称的 SQLManager 实例
      default @NotNull cc.carm.lib.easysql.api.SQLManager getNotNull​(@Nullable java.lang.String name)
      获取原生注册的指定名称的 SQLManager 实例，并要求其不得为空
      @NotNull java.util.Optional<? extends cc.carm.lib.easysql.api.SQLManager> getOptional​(@Nullable java.lang.String name)
      获取原生注册的指定名称的 SQLManager 实例
      @Unmodifiable @NotNull java.util.Map<java.lang.String,​? extends cc.carm.lib.easysql.api.SQLManager> list()
      获取某命名空间下所有 SQLManager 实例
      void register​(@NotNull java.lang.String name, @NotNull cc.carm.lib.easysql.api.SQLManager sqlManager)
      注册一个新的 SQLManager 实例
      @NotNull cc.carm.lib.easysql.api.SQLManager unregister​(@NotNull java.lang.String name)
      从注册池中注销一个新的 SQLManager 实例

    • Method Detail

      • get

        @Nullable
default @Nullable cc.carm.lib.easysql.api.SQLManager get()
        获取原生注册的首个 SQLManager 实例
        Returns:
        SQLManager 实例

      • get

        @Nullable
default @Nullable cc.carm.lib.easysql.api.SQLManager get​(@Nullable
                                                         @Nullable java.lang.String name)
        获取原生注册的指定名称的 SQLManager 实例
        Parameters:
        name - 要获取的 SQLManager 实例名称, 如果为 null 则获取首个实例
        Returns:
        SQLManager 实例

      • getNotNull

        @NotNull
default @NotNull cc.carm.lib.easysql.api.SQLManager getNotNull​(@Nullable
                                                               @Nullable java.lang.String name)
                                                        throws java.lang.NullPointerException
        获取原生注册的指定名称的 SQLManager 实例，并要求其不得为空
        Parameters:
        name - 要获取的 SQLManager 实例名称, 如果为 null 则获取首个实例
        Returns:
        SQLManager 实例
        Throws:
        java.lang.NullPointerException - 若不存在对应实例则抛出空指针异常

      • getOptional

        @NotNull
@NotNull java.util.Optional<? extends cc.carm.lib.easysql.api.SQLManager> getOptional​(@Nullable
                                                                                      @Nullable java.lang.String name)
        获取原生注册的指定名称的 SQLManager 实例
        Parameters:
        name - 要获取的 SQLManager 实例名称, 如果为 null 则获取首个实例
        Returns:
        SQLManager 实例

      • list

        @NotNull
@Unmodifiable @NotNull java.util.Map<java.lang.String,​? extends cc.carm.lib.easysql.api.SQLManager> list()
        获取某命名空间下所有 SQLManager 实例
        Returns:
        SQLManager 实例集合

      • register

        void register​(@NotNull
              @NotNull java.lang.String name,
              @NotNull
              @NotNull cc.carm.lib.easysql.api.SQLManager sqlManager)
       throws java.lang.IllegalStateException
        注册一个新的 SQLManager 实例
        Parameters:
        name - 实例名称
        sqlManager - 实例
        Throws:
        java.lang.IllegalStateException - 当所要注册的实例已经存在时抛出

      • unregister

        @NotNull
@NotNull cc.carm.lib.easysql.api.SQLManager unregister​(@NotNull
                                                       @NotNull java.lang.String name)
                                                throws java.lang.NullPointerException
        从注册池中注销一个新的 SQLManager 实例
        Parameters:
        name - 实例名称
        Returns:
        所被注销的 SQLManager
        Throws:
        java.lang.NullPointerException - 当所要注销的实例不存在时抛出