public interface

ProgressCallback

org.mybatis.generator.api.ProgressCallback
Known Indirect Subclasses

Class Overview

This interface can be implemented to return progress information from the file generation process. During the execution of code generation, there are three main operations: database introspection, code generation based on the results of introspection, and then merging/saving generated files. Methods in this interface accordingly and in this order:

  1. introspectionStarted(int)
  2. (Repeatedly) startTask(String)
  3. generationStarted(int)
  4. (Repeatedly) startTask(String)
  5. saveStarted(int)
  6. (Repeatedly) startTask(String)
  7. done()

Periodically, the checkCancel() method will be called to see if the method should be canceled.

For planning purposes, the most common use case will have a ratio of 20% introspection tasks, 40% generation tasks, and 40% save tasks.

Summary

Public Methods
abstract void checkCancel()
The method is called periodically during a long running method.
abstract void done()
This method is called when all generated files have been saved
abstract void generationStarted(int totalTasks)
Called to note the start of the generation phase, and to note the maximum number of startTask messages that will be sent for the generation phase.
abstract void introspectionStarted(int totalTasks)
Called to note the start of the introspection phase, and to note the maximum number of startTask messages that will be sent for the introspection phase.
abstract void saveStarted(int totalTasks)
Called to note the start of the file saving phase, and to note the maximum number of startTask messages that will be sent for the file saving phase phase.
abstract void startTask(String taskName)
Called to denote the beginning of a save task

Public Methods

public abstract void checkCancel ()

The method is called periodically during a long running method. If the the implementation throws InterruptedException then the method will be canceled. Any files that have already been saved will remain on the file system.

Throws
InterruptedException if the operation should be halted

public abstract void done ()

This method is called when all generated files have been saved

public abstract void generationStarted (int totalTasks)

Called to note the start of the generation phase, and to note the maximum number of startTask messages that will be sent for the generation phase.

Parameters
totalTasks the maximum number of times startTask will be called for the generation phase.

public abstract void introspectionStarted (int totalTasks)

Called to note the start of the introspection phase, and to note the maximum number of startTask messages that will be sent for the introspection phase.

Parameters
totalTasks the maximum number of times startTask will be called for the introspection phase.

public abstract void saveStarted (int totalTasks)

Called to note the start of the file saving phase, and to note the maximum number of startTask messages that will be sent for the file saving phase phase.

Parameters
totalTasks the maximum number of times startTask will be called for the file saving phase.

public abstract void startTask (String taskName)

Called to denote the beginning of a save task

Parameters
taskName a descriptive name of the current work step