org.evolvis.tartools.backgroundjobs

Class CompositeBackgroundJob.SubJobMonitor

java.lang.Object

org.evolvis.tartools.backgroundjobs.CompositeBackgroundJob.SubJobMonitor

All Implemented Interfaces:

BackgroundJobMonitor

Enclosing class:

CompositeBackgroundJob

public class CompositeBackgroundJob.SubJobMonitor
extends Object
implements BackgroundJobMonitor

Nested Class Summary

Nested classes/interfaces inherited from interface org.evolvis.tartools.backgroundjobs.BackgroundJobMonitor

BackgroundJobMonitor.Severity

Constructor Summary

Constructors

Constructor and Description
SubJobMonitor(BackgroundJobMonitor monitor, int anteilVomGanzen)

Method Summary

Modifier and Type	Method and Description
void	announceTotal(int totalItems) Announce the total amount of work to be done.
String	getScheduledJobId() Get the identifier assigned to the BackgroundJob by the scheduler.
boolean	isAborting() Whether the cancellation of the job was requested.
void	log(BackgroundJobMonitor.Severity severity, Object message) write to the (job-specific) log.
void	reportProgressAbsolute(int items) Report units of work completed since the begining of the job.
void	reportProgressIncrement(int items) Report units of work completed since the last progress report.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubJobMonitor

public SubJobMonitor(BackgroundJobMonitor monitor,
                     int anteilVomGanzen)

Method Detail

getScheduledJobId

public String getScheduledJobId()

Description copied from interface: BackgroundJobMonitor

Get the identifier assigned to the BackgroundJob by the scheduler.
This ID uniquely identifies the job instance among all jobs managed by the scheduler. Since a single job instance is never executed more than once, it equivalently identifies that particular execution.

Specified by:

getScheduledJobId in interface BackgroundJobMonitor

Returns:

the id.

log

public void log(BackgroundJobMonitor.Severity severity,
                Object message)

Description copied from interface: BackgroundJobMonitor

write to the (job-specific) log.

Specified by:

log in interface BackgroundJobMonitor

announceTotal

public void announceTotal(int totalItems)

Description copied from interface: BackgroundJobMonitor

Announce the total amount of work to be done.

The BackgroundJob should call this method at the beginning of its execution, as soon as it knows what lies ahead. It is ok to call this method multiple times with different values to update an initial assessment as new/more detailed information about the work to be done becomes available.

Specified by:

announceTotal in interface BackgroundJobMonitor

Parameters:

totalItems - the total units of work to be done.

reportProgressIncrement

public void reportProgressIncrement(int items)

Description copied from interface: BackgroundJobMonitor

Report units of work completed since the last progress report.

The BackgroundJob can use this method to report relative increments.

Specified by:

reportProgressIncrement in interface BackgroundJobMonitor

Parameters:

items - number of units of work completed since the last call.

reportProgressAbsolute

public void reportProgressAbsolute(int items)

Description copied from interface: BackgroundJobMonitor

Report units of work completed since the begining of the job.

The BackgroundJob can use this method to report the absolute amount of work that was tackled since the execution started.

Specified by:

reportProgressAbsolute in interface BackgroundJobMonitor

Parameters:

items - number of units of work completed since execution started.

isAborting

public boolean isAborting()

Description copied from interface: BackgroundJobMonitor

Whether the cancellation of the job was requested.

When true is returned, the scheduler has already tried set the interrupt flag on the thread executing the job. BackgroundJobs should poll this method in regular intervals and exit as quickly as possible if true is returned.

Specified by:

isAborting in interface BackgroundJobMonitor

Returns:

true, if the job should abort its execution.