Package org.jdbi.v3.sqlobject

Class HandlerDecorators

java.lang.Object
org.jdbi.v3.sqlobject.HandlerDecorators
All Implemented Interfaces:
JdbiConfig<HandlerDecorators>
@Deprecated(since="3.38.0", forRemoval=true) public class HandlerDecorators extends Object implements JdbiConfig<HandlerDecorators>
Deprecated, for removal: This API element is subject to removal in a future version.
Use ExtensionHandlerCustomizer instances which are returned directly from the ExtensionFactory.getExtensionHandlerCustomizers(ConfigRegistry).
Registry for handler decorators. Decorators may modify or augment the behavior of a method Handler in some way. Out of the box, a decorator is registered which applies decorations for any decorating annotations present on a SQL method. For example, using the Transaction annotation will cause a SQL method to be executed within a transaction. Decorators are applied in the order registered, from innermost to outermost: the last registered decorator will be the outermost decorator around the method handler.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HandlerDecorators()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Handler
    applyDecorators(Handler base, Class<?> sqlObjectType, Method method)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Applies all registered decorators to the given handler
    HandlerDecorators
    createCopy()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns a copy of this configuration object.
    HandlerDecorators
    register(HandlerDecorator decorator)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Registers the given handler decorator with the registry.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.jdbi.v3.core.config.JdbiConfig

    setRegistry

  • Constructor Details

    • HandlerDecorators

      public HandlerDecorators()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • register

      public HandlerDecorators register(HandlerDecorator decorator)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Registers the given handler decorator with the registry.
      Parameters:
      decorator - the decorator to register
      Returns:
      this

    • applyDecorators

      public Handler applyDecorators(Handler base, Class<?> sqlObjectType, Method method)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Applies all registered decorators to the given handler
      Parameters:
      base - the base handler
      sqlObjectType - the SQL object type
      method - the SQL method to be decorated
      Returns:
      the decorated handler

    • createCopy

      public HandlerDecorators createCopy()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: JdbiConfig
      Returns a copy of this configuration object. Changes to the copy should not modify the original, and vice-versa.
      Specified by:
      createCopy in interface JdbiConfig<HandlerDecorators>
      Returns:
      a copy of this configuration object.