Module org.jooq
Package org.jooq

Interface MigrationListenerProvider

All Known Implementing Classes:
DefaultMigrationListenerProvider
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @Internal public interface MigrationListenerProvider
A provider for MigrationListener instances.

In order to facilitate the lifecycle management of MigrationListener instances that are provided to a jOOQ Configuration, clients can implement this API. To jOOQ, it is thus irrelevant, if migration listeners are stateful or stateless, local to an execution, or global to an application.

This is EXPERIMENTAL functionality and subject to change in future jOOQ versions.

Author:
Lukas Eder
See Also:
MigrationListener, Configuration

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull MigrationListener
    provide()
    Provide an MigrationListener instance.

  • Method Details

    • provide

      @NotNull @NotNull MigrationListener provide()
      Provide an MigrationListener instance.

      Implementations are free to choose whether this method returns new instances at every call or whether the same instance is returned repetitively.

      An MigrationListener shall be provided exactly once per Migration execution lifecycle, i.e. per MigrationContext.

      Returns:
      An MigrationListener instance.
      See Also:
      MigrationListener, MigrationContext, DefaultMigrationListenerProvider