Package org.jdbi.v3.sqlobject

Interface HandlerFactory

All Superinterfaces:
ExtensionHandlerFactory
@Deprecated(since="3.38.0", forRemoval=true) public interface HandlerFactory extends ExtensionHandlerFactory
Deprecated, for removal: This API element is subject to removal in a future version.
Use ExtensionHandlerFactory instances directly.
Creates Handler objects for methods annotated with a specific SQL method annotation, which satisfy the contract of that annotation.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    accepts(Class<?> extensionType, Method method)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Determines whether the factory can create an ExtensionHandler for combination of extension type and method.
    Optional<Handler>
    buildHandler(Class<?> sqlObjectType, Method method)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a Handler instance for executing the given SQL Object method.
    default Optional<ExtensionHandler>
    createExtensionHandler(Class<?> extensionType, Method method)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns an ExtensionHandler instance for a extension type and method combination.

  • Method Details

    • buildHandler

      Optional<Handler> buildHandler(Class<?> sqlObjectType, Method method)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a Handler instance for executing the given SQL Object method.
      Parameters:
      sqlObjectType - the SQL Object type
      method - the method
      Returns:
      a handler, if applicable

    • accepts

      default boolean accepts(Class<?> extensionType, Method method)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ExtensionHandlerFactory
      Determines whether the factory can create an ExtensionHandler for combination of extension type and method.
      Specified by:
      accepts in interface ExtensionHandlerFactory
      Parameters:
      extensionType - The extension type class
      method - A method
      Returns:
      True if the factory can create an extension handler for extension type and method, false otherwise

    • createExtensionHandler

      default Optional<ExtensionHandler> createExtensionHandler(Class<?> extensionType, Method method)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ExtensionHandlerFactory
      Returns an ExtensionHandler instance for a extension type and method combination.
      Specified by:
      createExtensionHandler in interface ExtensionHandlerFactory
      Parameters:
      extensionType - The extension type class
      method - A method
      Returns:
      An ExtensionHandler instance wrapped into an Optional. The optional can be empty. This is necessary to retrofit old code that does not have an accept/build code pair but unconditionally tries to build a handler and returns empty if it can not. New code should always return Optional.of(extensionHandler} and never return Optional.empty()