org.mybatis.generator.api.ProgressCallback |
![]() |
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:
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.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
The method is called periodically during a long running method.
| |||||||||||
This method is called when all generated files have been saved
| |||||||||||
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.
| |||||||||||
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.
| |||||||||||
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.
| |||||||||||
Called to denote the beginning of a save task
|
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.
InterruptedException | if the operation should be halted |
---|
This method is called when all generated files have been saved
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.
totalTasks | the maximum number of times startTask will be called for the generation phase. |
---|
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.
totalTasks | the maximum number of times startTask will be called for the introspection phase. |
---|
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.
totalTasks | the maximum number of times startTask will be called for the file saving phase. |
---|
Called to denote the beginning of a save task
taskName | a descriptive name of the current work step |
---|