org.eclipse.sphinx.xtendxpand.ui.jobs

Class ResultMessageHandler

java.lang.Object

org.eclipse.core.runtime.jobs.JobChangeAdapter

org.eclipse.sphinx.xtendxpand.jobs.AbstractM2xResultHandler

org.eclipse.sphinx.xtendxpand.ui.jobs.ResultMessageHandler

All Implemented Interfaces:

org.eclipse.core.runtime.jobs.IJobChangeListener

public class ResultMessageHandler
extends AbstractM2xResultHandler

An IJobChangeListener implementation that can be registered on an XpandJob, CheckJob or XtendJob instance or a M2TJob or M2MJob instance enclosing the latter and opens a message dialog indicating the result status of the same.

See Also:

XpandJob, XtendJob, CheckJob, M2TJob, M2MJob

Constructor Summary

Constructors

Constructor and Description
ResultMessageHandler() Constructs a result message handler that opens a message dialog indicating the result status of underlying M2x job, if failed.
ResultMessageHandler(int openDialogOn) Constructs a result message handler that opens a message dialog indicating the result status of underlying M2x job.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	capMessage(java.lang.String message)
void	handleResult(org.eclipse.core.runtime.jobs.Job m2xJob) Invoked for handling the result of last job that has completed execution.
protected void	handleResultMessage() Opens a message dialog that indicates the result status of underlying M2x job.

Methods inherited from class org.eclipse.sphinx.xtendxpand.jobs.AbstractM2xResultHandler

done, getCheckJob, getM2xJob, getXpandJob, getXtendJob

Methods inherited from class org.eclipse.core.runtime.jobs.JobChangeAdapter

aboutToRun, awake, running, scheduled, sleeping

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultMessageHandler

public ResultMessageHandler()

Constructs a result message handler that opens a message dialog indicating the result status of underlying M2x job, if failed.

ResultMessageHandler

public ResultMessageHandler(int openDialogOn)

Constructs a result message handler that opens a message dialog indicating the result status of underlying M2x job.

Parameters:

m2xJob - the M2TJob or M2MJob instance to be use.

openDialogOn - a bit indicating when the message is to be displayed (on completion only, or on cancellation only or on completion and cancellation, etc.).

Method Detail

handleResult

public void handleResult(org.eclipse.core.runtime.jobs.Job m2xJob)

Description copied from class: AbstractM2xResultHandler

Invoked for handling the result of last job that has completed execution.

Clients are expected to override this method and for implementing the required result handling behavior.

Specified by:

handleResult in class AbstractM2xResultHandler

Parameters:

m2xJob - The last job that has completed execution - same job instance as that returned by AbstractM2xResultHandler.getM2xJob() .

See Also:

AbstractM2xResultHandler.getM2xJob()

handleResultMessage

protected void handleResultMessage()

Opens a message dialog that indicates the result status of underlying M2x job.

capMessage

protected java.lang.String capMessage(java.lang.String message)