org.apache.ibatis.abator.internal
Class NullProgressCallback

java.lang.Object
  org.apache.ibatis.abator.internal.NullProgressCallback

All Implemented Interfaces:

ProgressCallback

public class NullProgressCallback
extends java.lang.Object
implements ProgressCallback

This class implements a progress callback that does nothing. It is used when the Abator client passes in a null for the ProgressCallback.

Author:

Jeff Butler

Constructor Summary

NullProgressCallback()

Method Summary

void	checkCancel() Abator will call this method periodically during a long running method.
void	finished() Abator calls this method when all subtasks are finished
void	setNumberOfSubTasks(int totalSubTasks) Called to designate the maximum number of startSubTask messages that will be sent.
void	startSubTask(java.lang.String subTaskName) Called to denote the beginning of another task

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NullProgressCallback

public NullProgressCallback()

Method Detail

finished

public void finished()

Description copied from interface: ProgressCallback

Abator calls this method when all subtasks are finished

Specified by:

finished in interface ProgressCallback

checkCancel

public void checkCancel()
                 throws java.lang.InterruptedException

Description copied from interface: ProgressCallback

Abator will call this method periodically during a long running method. If the the implementation throws InterruptedException, then the method will be cancelled. Any files that have already been saved will remain on the file system.

Specified by:

checkCancel in interface ProgressCallback

Throws:

java.lang.InterruptedException - if the main task should finish

setNumberOfSubTasks

public void setNumberOfSubTasks(int totalSubTasks)

Description copied from interface: ProgressCallback

Called to designate the maximum number of startSubTask messages that will be sent. It is not guaranteed that this number startSubTask messages will be sent. The actual number of messages depends on the objects generated from each table.

Specified by:

setNumberOfSubTasks in interface ProgressCallback

startSubTask

public void startSubTask(java.lang.String subTaskName)

Description copied from interface: ProgressCallback

Called to denote the beginning of another task

Specified by:

startSubTask in interface ProgressCallback

Parameters:

subTaskName - a descriptive name of the current work step