com.aspose.cells

Class ThreadInterruptMonitor

java.lang.Object

com.aspose.cells.AbstractInterruptMonitor

com.aspose.cells.ThreadInterruptMonitor

public class ThreadInterruptMonitor
extends AbstractInterruptMonitor

Simple implementation of AbstractInterruptMonitor by starting another thread to require the interruption after sleeping user specified limit.

Remarks

One monitor instance can be used repeatedly, as long as you monitor each process in sequence. It should not be used to monitor multiple procedures concurrently in multi-threads.

Example

The following example shows how to monitor the load and save procedure with specified time limit:

 
         ThreadInterruptMonitor monitor = new ThreadInterruptMonitor(false);
         LoadOptions lopts = new LoadOptions();
         lopts.setInterruptMonitor(monitor);
         monitor.startMonitor(1000); //time limit is 1 second
         Workbook wb = new Workbook("Large.xlsx", lopts);
         //if the time cost of loading the template file exceeds one second, interruption will be required and exception will be thrown here
         //otherwise finishes the monitor thread and starts to monitor the save procedure
         monitor.finishMonitor();
         monitor.startMonitor(1500); //time limit is 1.5 seconds
         wb.save("result.xlsx");
         monitor.finishMonitor();
 

Constructor Summary

Constructors

Constructor and Description
ThreadInterruptMonitor(boolean terminateWithoutException) Constructs one interruption monitor.

Method Summary

Methods

Modifier and Type	Method and Description
void	finishMonitor() Finishes the monitor for one procedure.
boolean	getTerminateWithoutException() See AbstractInterruptMonitor.getTerminateWithoutException().
boolean	isInterruptionRequested() This implementation just checks whether the time cost(from the time when starting this monitor to now) is greater than user specified limit.
void	startMonitor(int msLimit) Starts the monitor with the specified time limit.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadInterruptMonitor

public ThreadInterruptMonitor(boolean terminateWithoutException)

Constructs one interruption monitor.

Parameters:

terminateWithoutException - AbstractInterruptMonitor.getTerminateWithoutException()

Method Detail

startMonitor

public void startMonitor(int msLimit)

Starts the monitor with the specified time limit. The start time to calculate time cost is just when this method is called, so the procedure which needs to be monitored should be started just after this call.

Parameters:

msLimit - time limit(ms) to require the interruption.

finishMonitor

public void finishMonitor()

Finishes the monitor for one procedure.

Remarks

Calling this method after the monitored procedure can release the monitor thread earlier, especially when there is no interruption for it(the time cost of that procedure is less than the specified time limit).

isInterruptionRequested

public boolean isInterruptionRequested()

This implementation just checks whether the time cost(from the time when starting this monitor to now) is greater than user specified limit.

Specified by:

isInterruptionRequested in class AbstractInterruptMonitor

getTerminateWithoutException

public boolean getTerminateWithoutException()

See AbstractInterruptMonitor.getTerminateWithoutException(). This property is specified by user when constructing this monitor instance.

Overrides:

getTerminateWithoutException in class AbstractInterruptMonitor