org.scijava.module.process

Interface PreprocessorPlugin

All Superinterfaces:

Cancelable, Contextual, ModulePreprocessor, ModuleProcessor, SciJavaPlugin

All Known Implementing Classes:

AbstractInputHarvesterPlugin, AbstractPreprocessorPlugin, AbstractSingleInputPreprocessor, ActiveDisplayPreprocessor, CheckInputsPreprocessor, DebugPreprocessor, DefaultValuePreprocessor, FilePreprocessor, GatewayPreprocessor, InitPreprocessor, LoadInputsPreprocessor, SaveInputsPreprocessor, ServicePreprocessor, UIPreprocessor, ValidityPreprocessor

public interface PreprocessorPlugin
extends SciJavaPlugin, Contextual, ModulePreprocessor

A preprocessor plugin defines a step that occurs just prior to the actual execution of a Module. Typically, a preprocessor prepares the module for execution in some way, such as populating module inputs or checking prerequisites.

Preprocessor plugins discoverable at runtime must implement this interface and be annotated with @Plugin with attribute Plugin.type() = PreprocessorPlugin.class. While it possible to create a preprocessor plugin merely by implementing this interface, it is encouraged to instead extend AbstractPreprocessorPlugin, for convenience.

Author:

Curtis Rueden

See Also:

ModulePreprocessor

Method Summary

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.module.process.ModuleProcessor

process

Methods inherited from interface org.scijava.Cancelable

cancel, getCancelReason, isCanceled