JIPipeRunnable (jipipe 5.1.0-SNAPSHOT API)

All Superinterfaces:

Runnable

All Known Implementing Classes:

AbstractJIPipeRunnable, CollectBackupsRun, DeleteOldBackupsRun, ImagePlusResultImportRun, InlinedJIPipeRunnable, JIPipeArchiveProjectRun, JIPipeArchiveProjectToDirectoryRun, JIPipeArchiveProjectToZIPRun, JIPipeArtifactRepositoryApplyInstallUninstallRun, JIPipeArtifactRepositoryInstallArtifactRun, JIPipeArtifactRepositoryInstallManuallyRun, JIPipeArtifactRepositoryOperationRun, JIPipeArtifactRepositoryUninstallArtifactRun, JIPipeArtifactRepositoryUpdateCachedArtifactsRun, JIPipeCacheClearAllRun, JIPipeCacheClearOutdatedRun, JIPipeDataDisplayWrapperImportOperation.ImportDataRun, JIPipeDesktopAddNodesPanel.ReloadListRun, JIPipeDesktopApplyPluginManagerRun, JIPipeDesktopCollectTraceRun, JIPipeDesktopDataExporterRun, JIPipeDesktopDataTableToFilesByMetadataExporterRun, JIPipeDesktopDataTableToOutputExporterRun, JIPipeDesktopDataTableToZIPExporterRun, JIPipeDesktopDataViewerWindow.DownloadFullDataRun, JIPipeDesktopEasyInstallExternalEnvironmentInstaller, JIPipeDesktopExternalEnvironmentInstaller, JIPipeDesktopImportCachedSlotOutputRun, JIPipeDesktopLegacyAddNodePanel.ReloadListRun, JIPipeDesktopLoadResultDirectoryIntoCacheRun, JIPipeDesktopLoadResultZipIntoCacheRun, JIPipeDesktopNodeFinderDialogUI.ReloadListRun, JIPipeDesktopProjectReportUI.RebuildReportRun, JIPipeDesktopProjectTemplateDownloaderRun, JIPipeDesktopQuickRun, JIPipeDesktopSaveProjectAndCacheToDirectoryRun, JIPipeDesktopSaveProjectAndCacheToZipRun, JIPipeExternalEnvironmentInstaller, JIPipeExtractTemplateZipFileRun, JIPipeGraphRun, JIPipeNodeDatabaseBuilderRun, JIPipeResultCopyFilesByMetadataExporterRun, JIPipeThumbnailGenerationQueue.ThumbnailGenerationRun, NodeTemplateDownloaderRun, OMEImageResultImportRun, PruneBackupsRun, RawImage2DExporterRun, RenderPipelineRun, Scene3DToColladaExporter, SelectCondaEnvPythonInstaller, SelectSystemPythonInstaller, SelectVirtualEnvPythonInstaller, Stack2DExporterRun, Stack2DRendererRun, Video2DExporterRun
```
public interface JIPipeRunnable
extends Runnable
```
Runnable that can be scheduled, canceled, and reports progress

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`JIPipeRunnable.EnqeuedEventListener`
`static class`	`JIPipeRunnable.EnqueuedEvent` Generated when an `JIPipeRunnableWorker` was enqueued
`static class`	`JIPipeRunnable.EnqueuedEventEmitter`
`static class`	`JIPipeRunnable.FinishedEvent` Generated when an `JIPipeRunnableWorker` finished its work
`static class`	`JIPipeRunnable.FinishedEventEmitter`
`static interface`	`JIPipeRunnable.FinishedEventListener`
`static class`	`JIPipeRunnable.InterruptedEvent` Generated when work of an `JIPipeRunnableWorker` is interrupted
`static class`	`JIPipeRunnable.InterruptedEventEmitter`
`static interface`	`JIPipeRunnable.InterruptedEventListener`
`static class`	`JIPipeRunnable.ProgressEvent` Generated when an `JIPipeRunnableWorker` reports progress
`static class`	`JIPipeRunnable.ProgressEventEmitter`
`static interface`	`JIPipeRunnable.ProgressEventListener`
`static class`	`JIPipeRunnable.StartedEvent` Generated when an `JIPipeRunnableWorker` was started
`static class`	`JIPipeRunnable.StartedEventEmitter`
`static interface`	`JIPipeRunnable.StartedEventListener`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`JIPipeProgressInfo`	`getProgressInfo()` The info object that allows communication with the run
`UUID`	`getRunUUID()` Unique ID of this run
`String`	`getTaskLabel()` A name for the runnable
`default boolean`	`isLogSilent()` Determines if this run is being logged silently
`default void`	`onFinished(JIPipeRunnable.FinishedEvent event)` Called when this runnable finishes
`default void`	`onInterrupted(JIPipeRunnable.InterruptedEvent event)` Called when this runnable is interrupted
`void`	`setProgressInfo(JIPipeProgressInfo progressInfo)` Sets the progress info of this runnable

Methods inherited from interface java.lang.Runnable
run

- Method Detail
  - getRunUUID
```
UUID getRunUUID()
```
    Unique ID of this run
    
    Returns:
    
    the UUID
  - getProgressInfo
```
JIPipeProgressInfo getProgressInfo()
```
    The info object that allows communication with the run
    
    Returns:
    
    the info object
  - setProgressInfo
```
void setProgressInfo(JIPipeProgressInfo progressInfo)
```
    Sets the progress info of this runnable
    
    Parameters:
    
    progressInfo - the info object
  - getTaskLabel
```
String getTaskLabel()
```
    A name for the runnable
    
    Returns:
    
    the name
  - isLogSilent
```
default boolean isLogSilent()
```
    Determines if this run is being logged silently
    
    Returns:
    
    if logs are silent
  - onFinished
```
default void onFinished(JIPipeRunnable.FinishedEvent event)
```
    Called when this runnable finishes
    
    Parameters:
    
    event - the event
  - onInterrupted
```
default void onInterrupted(JIPipeRunnable.InterruptedEvent event)
```
    Called when this runnable is interrupted
    
    Parameters:
    
    event - the event

Interface JIPipeRunnable

Nested Class Summary

Method Summary

Methods inherited from interface java.lang.Runnable

Method Detail

getRunUUID

getProgressInfo

setProgressInfo

getTaskLabel

isLogSilent

onFinished

onInterrupted