Class Handles

java.lang.Object
org.jdbi.v3.core.Handles
All Implemented Interfaces:
JdbiConfig<Handles>
public class Handles extends Object implements JdbiConfig<Handles>
Configuration class for handles.

  • Constructor Details

    • Handles

      public Handles()

  • Method Details

    • isForceEndTransactions

      public boolean isForceEndTransactions()
      Returns whether to enforce transaction termination discipline when a Handle is closed. This check is enabled by default. If enabled, and a handle is closed while a transaction is active (i.e. not committed or rolled back), an exception will be thrown.
      This check does not apply to handles allocated with a connection that already has an open transaction.
      Returns:
      whether to enforce transaction termination discipline when a Handle is closed.

    • setForceEndTransactions

      public void setForceEndTransactions(boolean forceEndTransactions)
      Sets whether to enforce transaction termination discipline when a Handle is closed.
      Parameters:
      forceEndTransactions - whether to enforce transaction termination discipline.

    • addListener

      public Handles addListener(HandleListener handleListener)
      Add a HandleListener which is called for specific events. Adding a listener will add it to all Handles that are subsequently created (this call does not affect existing handles).
      Parameters:
      handleListener - A HandleListener object.
      Returns:
      The Handles object itself.

    • removeListener

      public Handles removeListener(HandleListener handleListener)
      Remove a HandleListener. Removing a listener will only affect Handles that are subsequently created, not existing handles.
      Parameters:
      handleListener - A HandleListener object.
      Returns:
      The Handles object itself.

    • getListeners

      public Set<HandleListener> getListeners()
      Returns the collection of HandleListener objects. This set is immutable.
      Returns:
      A set of HandleListener objects. The set is never null, can be empty and is immutable.

    • createCopy

      public Handles createCopy()
      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<Handles>
      Returns:
      a copy of this configuration object.