com.norconex.jef.progress
Class JobProgressStateChangeAdapter

java.lang.Object
  extended by com.norconex.jef.progress.JobProgressAdapter
      extended by com.norconex.jef.progress.JobProgressStateChangeAdapter
All Implemented Interfaces:
IJobProgressListener

public class JobProgressStateChangeAdapter
extends JobProgressAdapter

Adapter for a job life-cycle, focusing on progress state changes. The methods jobFinished, jobProgressed, jobStarted, jobResumed all invoke jobStateChanged for convenience. Override that method for common behaviour upon any type of state change.

Author:
Pascal Essiembre

Constructor Summary
JobProgressStateChangeAdapter()
           
 
Method Summary
 void jobCompleted(IJobStatus progress)
          Invoked after a job normally finished its execution.
 void jobProgressed(IJobStatus progress)
          Invoked every time the progress state changes.
 void jobResumed(IJobStatus progress)
          Invoked just before a job resumes its execution.
 void jobStarted(IJobStatus progress)
          Invoked just before a job begins its execution.
 void jobStateChanged(IJobStatus progress)
          Invoked when any of the following are invoked (unless they are overridden): jobTerminatedPrematuraly, jobProgressed, jobStarted, jobResumed, jobStopping, jobStopped, jobCompleted.
 void jobStopped(IJobStatus progress)
          Invoked just after has stopped.
 void jobStopping(IJobStatus progress)
          Invoked just before a job starts to stop.
 void jobTerminatedPrematuraly(IJobStatus progress)
          Invoked after a job finished its execution before progress was 100% complete.
 
Methods inherited from class com.norconex.jef.progress.JobProgressAdapter
jobRunningVerified, jobSkipped
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JobProgressStateChangeAdapter

public JobProgressStateChangeAdapter()
Method Detail

jobTerminatedPrematuraly

public final void jobTerminatedPrematuraly(IJobStatus progress)
Description copied from interface: IJobProgressListener
Invoked after a job finished its execution before progress was 100% complete.

Specified by:
jobTerminatedPrematuraly in interface IJobProgressListener
Overrides:
jobTerminatedPrematuraly in class JobProgressAdapter
Parameters:
progress - job progress

jobProgressed

public final void jobProgressed(IJobStatus progress)
Description copied from interface: IJobProgressListener
Invoked every time the progress state changes.

Specified by:
jobProgressed in interface IJobProgressListener
Overrides:
jobProgressed in class JobProgressAdapter
Parameters:
progress - job progress

jobStarted

public final void jobStarted(IJobStatus progress)
Description copied from interface: IJobProgressListener
Invoked just before a job begins its execution.

Specified by:
jobStarted in interface IJobProgressListener
Overrides:
jobStarted in class JobProgressAdapter
Parameters:
progress - job progress

jobResumed

public final void jobResumed(IJobStatus progress)
Description copied from interface: IJobProgressListener
Invoked just before a job resumes its execution.

Specified by:
jobResumed in interface IJobProgressListener
Overrides:
jobResumed in class JobProgressAdapter
Parameters:
progress - job progress

jobStopped

public void jobStopped(IJobStatus progress)
Description copied from interface: IJobProgressListener
Invoked just after has stopped.

Specified by:
jobStopped in interface IJobProgressListener
Overrides:
jobStopped in class JobProgressAdapter
Parameters:
progress - job progress

jobStopping

public void jobStopping(IJobStatus progress)
Description copied from interface: IJobProgressListener
Invoked just before a job starts to stop.

Specified by:
jobStopping in interface IJobProgressListener
Overrides:
jobStopping in class JobProgressAdapter
Parameters:
progress - job progress

jobCompleted

public void jobCompleted(IJobStatus progress)
Description copied from interface: IJobProgressListener
Invoked after a job normally finished its execution.

Specified by:
jobCompleted in interface IJobProgressListener
Overrides:
jobCompleted in class JobProgressAdapter
Parameters:
progress - job progress

jobStateChanged

public void jobStateChanged(IJobStatus progress)
Invoked when any of the following are invoked (unless they are overridden): jobTerminatedPrematuraly, jobProgressed, jobStarted, jobResumed, jobStopping, jobStopped, jobCompleted.

Parameters:
progress - progress that changed


Copyright © 2007-2013 Norconex Inc.. All Rights Reserved.