Gephi Toolkit Javadoc

org.gephi.utils.longtask.spi
Interface LongTask

All Known Subinterfaces:
Generator
All Known Implementing Classes:
AbstractRenderTarget, ClusteringCoefficient, ConnectedComponents, Degree, DynamicClusteringCoefficient, DynamicDegree, DynamicGraph, EigenvectorCentrality, ExporterCSV, ExporterDL, ExporterGDF, ExporterGEXF, ExporterGML, ExporterGraphML, ExporterPajek, ExporterVNA, GraphDistance, Hits, ImporterCSV, ImporterDL, ImporterDOT, ImporterGDF, ImporterGEXF, ImporterGML, ImporterGraphML, ImporterPajek, ImporterTLP, ImporterVNA, LoadTask, Modularity, PageRank, PDFExporter, PDFRenderTargetBuilder.PDFRenderTargetImpl, PNGExporter, ProcessingRenderTargetBuilder.ProcessingTargetImpl, RandomGraph, SaveTask, SVGExporter, SVGRenderTargetBuilder.SVGRenderTargetImpl, WeightedDegree

public interface LongTask

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

Author:
Mathieu Bastian

Method Summary
 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

Gephi Toolkit Javadoc