hu.scelightapibase.service.job

Interface IJob

All Superinterfaces:

HasRIcon, IControlledThread, INormalThread

All Known Subinterfaces:

IProgressJob

public interface IJob
extends IControlledThread, HasRIcon

A monitored background job.

Running instances created and returned by the API appear in the Running Jobs dialog inside Scelight.

Example usage of IJob:

 

 // Use an image stored next to this class as the job icon:
 IRIcon ricon = factory.newRIcon( getClass().getResource( "job-icon.png" ) );
 
 IJob job; // If your runnable needs the reference: must be instance attribute or else a reference wrapper
 
 job = factory.newJob( "Italian Job", ricon, new Runnable() {
        public void run() {
                System.out.println( "I am a Job, doing the job." );
        }
 } );
 
 // Start the job:
 job.start();
 
 

Author:

Andras Belicza

See Also:

IFactory.newJob(String, IRIcon, Runnable), IProgressJob

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getStartedAt() Returns the job execution start time.
void	setCallback(java.lang.Runnable callback) Sets the callback to be called when job is done.
void	setEdtCallback(java.lang.Runnable edtCallback) Sets the callback to be called in the EDT when job is done.
java.lang.String	toString() Overridden to return the job's name.

Methods inherited from interface hu.scelightapibase.util.IControlledThread

close, getControlledState, getExecTimeMs, getPausedTimeMs, guestMayContinue, guestWaitIfPaused, isCancelRequested, isPauseRequested, mayContinue, requestCancel, requestPause, requestUnpause, waitIfPaused

Methods inherited from interface hu.scelightapibase.util.INormalThread

asThread, checkedSleep, start, waitToFinish

Methods inherited from interface hu.scelightapibase.util.gui.HasRIcon

getRicon

Method Detail

setCallback

void setCallback(java.lang.Runnable callback)

Sets the callback to be called when job is done.

Parameters:

callback - callback to be set

setEdtCallback

void setEdtCallback(java.lang.Runnable edtCallback)

Sets the callback to be called in the EDT when job is done.

Parameters:

edtCallback - EDT callback to be set

getStartedAt

java.util.Date getStartedAt()

Returns the job execution start time.

Returns:

the job execution start time

toString

java.lang.String toString()

Overridden to return the job's name.

Overrides:

toString in class java.lang.Object

Returns:

the job's name