org.hkijena.jipipe

Interface JIPipePlugin

All Superinterfaces:

JIPipeDependency, JIPipeValidatable

All Known Subinterfaces:

JIPipeJavaPlugin

All Known Implementing Classes:

AnnotationsPlugin, ArtifactsPlugin, BatchAssistantPlugin, CellposePlugin, CLIJPlugin, CorePlugin, CorePythonPlugin, DataDirectoriesPlugin, DevelopmentPlugin, ExpressionPlugin, FilamentsPlugin, FilesystemPlugin, FormsPlugin, GraphAnnotationPlugin, GroupingPlugin, IJ3DPlugin, IlastikPlugin, ImageJ2Plugin, ImageJAlgorithmsPlugin, ImageJDataTypesPlugin, ImpPlugin, JIPipeCompartmentsPlugin, JIPipeDefaultJavaPlugin, JIPipeJsonPlugin, JIPipePrepackagedDefaultJavaPlugin, JsonExtensionLoaderPlugin, LoopingPlugin, MultiParameterAlgorithmsPlugin, MultiParametersPlugin, MultiTemplateMatchingPlugin, NapariPlugin, NodeTemplateBoxToolPlugin, OCRPlugin, OMEROPlugin, OmniposePlugin, OpenCvPlugin, PipelineRenderPlugin, PlotsPlugin, ProcessesPlugin, PythonPlugin, RPlugin, Scene3DPlugin, StandardParametersPlugin, StandardSettingsPlugin, StringsPlugin, TablesPlugin, ToolsPlugin, TrackMatePlugin, UtilitiesPlugin, WekaPlugin

public interface JIPipePlugin
extends JIPipeDependency

Interface shared between all JIPipe extensions

Method Summary

Modifier and Type	Method and Description
default boolean	canActivate(JIPipeValidationReport report, JIPipeProgressInfo progressInfo) Returns true if the extension can be activated.
default boolean	isActivated() Returns true if the extension is activated.
default boolean	isBeta() Returns whether this extension is in beta testing.
default boolean	isCorePlugin() Returns whether this extension is a core extension and thus cannot be disabled by users.
default boolean	isScheduledForActivation() Returns true if the extension is scheduled to be activated upon the next restart
default boolean	isScheduledForDeactivation() Returns true if the extension is scheduled to be deactivated upon the next restart

Methods inherited from interface org.hkijena.jipipe.JIPipeDependency

getAllDependencies, getAllDependencies, getAllImageJUpdateSiteDependencies, getDependencies, getDependencyId, getDependencyLocation, getDependencyProvides, getDependencyVersion, getImageJUpdateSiteDependencies, getImageJUpdateSites, getMetadata, reportValidity, simplifyAndMinimize, toHtmlElement

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Method Detail

canActivate

default boolean canActivate(JIPipeValidationReport report,
                            JIPipeProgressInfo progressInfo)

Returns true if the extension can be activated. This is a hard check that is applied during the JIPipe registration Avoid to use this method if possible (e.g. by depending on an ImageJ update site), as the extension will not be loaded at all

Parameters:

report - the report associated with this extension

progressInfo - allows to write information into the startup log

Returns:

if the extension can be activated

isActivated

default boolean isActivated()

Returns true if the extension is activated. Utilizes the extension ID (default)

Returns:

if the extension is active

isScheduledForActivation

default boolean isScheduledForActivation()

Returns true if the extension is scheduled to be activated upon the next restart

Returns:

if the extension is scheduled to be activated

isScheduledForDeactivation

default boolean isScheduledForDeactivation()

Returns true if the extension is scheduled to be deactivated upon the next restart

Returns:

if the extension is scheduled to be deactivated

isCorePlugin

default boolean isCorePlugin()

Returns whether this extension is a core extension and thus cannot be disabled by users. Defaults to false. Please be sure if you really want to mark an extension as core extension.

Returns:

if the extension cannot be disabled

isBeta

default boolean isBeta()

Returns whether this extension is in beta testing. If true, users should expect significant changes in how the extension and its nodes work.

Returns:

if the extension is in beta