org.gephi.utils.longtask.spi

Interface LongTask

All Known Subinterfaces:

Generator

public interface LongTask

Interface that any class can implement to support progress and cancellation.

Author:

Mathieu Bastian

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancel the task.
void	setProgressTicket(ProgressTicket progressTicket) Set the progress ticket for the long task.

Method Detail

cancel

boolean cancel()

Cancel the task. Returns true if the task has been sucessfully cancelled, false otherwise.

Returns:

true if the task has been sucessfully cancelled, false otherwise

setProgressTicket

void setProgressTicket(ProgressTicket progressTicket)

Set the progress ticket for the long task. Can't be null.

Parameters:

progressTicket - the progress ticket for this task