Module org.jooq
Package org.jooq

Interface ResourceManagingScope

All Superinterfaces:
Scope
All Known Subinterfaces:
BindingSetSQLOutputContext<U>, BindingSetStatementContext<U>
public interface ResourceManagingScope extends Scope
A scope that can manage resources.

This is a type of Scope that can manage resources on behalf of the call site, and free / close those resources once the scope ends.

For example, Binding implementations may wish to create Clob or InputStream or other kinds of resources in order to bind them to JDBC. Instead of remembering to close them manually through some delicate logic involving e.g. clever usage of ThreadLocal, implementations can register their resources with the methods exposed here, and jOOQ will take care of freeing / closing them at the right moment.

Example: 


 class StreamingLobBinding implements Binding<String, File> {
     ...
     public void set(BindingSetStatementContext<File> ctx) {
         ctx.statement()
            .setBinaryStream(ctx.index(), ctx.closeAfterExecution(new FileInputStream(ctx.value())));
     }
 }

This type is a Scope with whose lifecycle is typically tied to an ExecuteContext, sharing the latter's Scope.data() map.

Author:
Lukas Eder

  • Method Details

    • autoFree

      Array autoFree(Array array)
      Register a Array for auto freeing after this scope ends.
      Returns:
      The argument array, for convenience.

    • autoFree

      Blob autoFree(Blob blob)
      Register a Blob for auto freeing after this scope ends.
      Returns:
      The argument blob, for convenience.

    • autoFree

      Clob autoFree(Clob clob)
      Register a Clob for auto freeing after this scope ends.
      Returns:
      The argument clob, for convenience.

    • autoFree

      SQLXML autoFree(SQLXML xml)
      Register a SQLXML for auto freeing after this scope ends.
      Returns:
      The argument xml, for convenience.

    • autoClose

      <R extends Closeable> R autoClose(R closeable)
      Register a Closeable for auto closing after this scope ends.
      Returns:
      The argument closeable, for convenience.

    • autoClose

      <R extends AutoCloseable> R autoClose(R closeable)
      Register an AutoCloseable for auto closing after this scope ends.
      Returns:
      The argument closeable, for convenience.