org.scijava.plugin

Interface SciJavaPlugin

All Known Subinterfaces:

App, AppEventService, AppService, ButtonWidget<U>, CacheService, ChoiceWidget<U>, CodeRunner, ColorWidget<U>, Command, CommandService, ConsoleArgument, ConsoleService, Converter<I,O>, ConvertService, DataHandle<L>, DataHandleService, DateWidget<U>, Display<T>, DisplayService, DisplayViewer<T>, DownloadService, DragAndDropHandler<D>, DragAndDropService, EventHistory, EventService, FileListWidget<U>, FileWidget<U>, Gateway, HandlerPlugin<D>, HandlerService<DT,PT>, IconService, InputService, InputWidget<T,W>, IOPlugin<D>, IOService, LocationResolver, LocationService, LogService, MainService, MenuService, MessageWidget<U>, ModuleService, NIOService, NumberWidget<U>, ObjectService, ObjectWidget<U>, OptionsService, ParseService, Platform, PlatformService, PluginService, PostprocessorPlugin, PrefService, PreprocessorPlugin, PTService<PT>, RecentFileService, ResettableStreamHandle<L>, RichPlugin, RunService, SciJavaService, ScriptHeader, ScriptHeaderService, ScriptLanguage, ScriptProcessor, ScriptProcessorService, ScriptService, SeekableStreamHandle<L>, Service, SingletonPlugin, SingletonService<PT>, StartupService, StatusService, StreamHandle<L>, TaskService, TextDisplay, TextDisplayViewer, TextFormat, TextIOService, TextService, TextWidget<U>, ThreadService, ToggleWidget<U>, Tool, ToolService, TypedIOService<D>, TypedPlugin<D>, TypedService<DT,PT>, UIService, UserInterface, WelcomeService, WidgetService, WrapperPlugin<D>, WrapperService<DT,PT>

All Known Implementing Classes:

AbstractApp, AbstractCodeRunner, AbstractConsoleArgument, AbstractConverter, AbstractConvertService, AbstractDataHandle, AbstractDelegateConverter, AbstractDisplay, AbstractDisplayViewer, AbstractDragAndDropHandler, AbstractGateway, AbstractHandlerPlugin, AbstractHandlerService, AbstractHigherOrderHandle, AbstractInputHarvesterPlugin, AbstractInputWidget, AbstractIOPlugin, AbstractLocationResolver, AbstractLogService, AbstractPlatform, AbstractPostprocessorPlugin, AbstractPrefService, AbstractPreprocessorPlugin, AbstractPTService, AbstractRichPlugin, AbstractScriptHeader, AbstractScriptLanguage, AbstractSeekableStreamHandle, AbstractService, AbstractSingleInputPreprocessor, AbstractSingletonService, AbstractStreamHandle, AbstractTextDisplayViewer, AbstractTextFormat, AbstractTool, AbstractTypedIOService, AbstractTypedPlugin, AbstractTypedService, AbstractUIInputWidget, AbstractUserInterface, AbstractWrapperPlugin, AbstractWrapperService, ActiveDisplayPreprocessor, AdaptedScriptLanguage, ArrayConverters.BoolArrayUnwrapper, ArrayConverters.BoolArrayWrapper, ArrayConverters.ByteArrayUnwrapper, ArrayConverters.ByteArrayWrapper, ArrayConverters.CharArrayUnwrapper, ArrayConverters.CharArrayWrapper, ArrayConverters.DoubleArrayUnwrapper, ArrayConverters.DoubleArrayWrapper, ArrayConverters.FloatArrayUnwrapper, ArrayConverters.FloatArrayWrapper, ArrayConverters.IntArrayUnwrapper, ArrayConverters.IntArrayWrapper, ArrayConverters.LongArrayUnwrapper, ArrayConverters.LongArrayWrapper, ArrayConverters.ShortArrayUnwrapper, ArrayConverters.ShortArrayWrapper, ArrayToStringConverter, BytesHandle, CastingConverter, CheckInputsPreprocessor, CommandCodeRunner, ContextCommand, DebugPostprocessor, DebugPreprocessor, DefaultAppEventService, DefaultAppService, DefaultCacheService, DefaultCommandService, DefaultConsoleService, DefaultConverter, DefaultConvertService, DefaultDataHandleService, DefaultDisplay, DefaultDisplayService, DefaultDownloadService, DefaultDragAndDropService, DefaultEventHistory, DefaultEventService, DefaultInputService, DefaultIOService, DefaultLocationService, DefaultMainService, DefaultMenuService, DefaultModuleService, DefaultNIOService, DefaultObjectService, DefaultOptionsService, DefaultParseService, DefaultPlatform, DefaultPlatformService, DefaultPluginService, DefaultPrefService, DefaultRecentFileService, DefaultRunService, DefaultScriptHeaderService, DefaultScriptProcessorService, DefaultScriptService, DefaultStartupService, DefaultStatusService, DefaultTaskService, DefaultTextDisplay, DefaultTextIOService, DefaultTextService, DefaultThreadService, DefaultToolService, DefaultUIService, DefaultValuePreprocessor, DefaultWelcomeService, DefaultWidgetService, DirectiveScriptProcessor, DisplayPostprocessor, DummyHandle, DummyTool, DynamicCommand, FileDragAndDropHandler, FileHandle, FileListConverters.FileArrayToStringConverter, FileListConverters.FileToStringConverter, FileListConverters.StringToFileArrayConverter, FileListConverters.StringToFileConverter, FileListPreprocessor, FileLocationResolver, FilePreprocessor, FileToPathConverter, GatewayPreprocessor, HeadlessArgument, HeadlessDisplayViewer, HeadlessUI, HeadlessUI, InitPreprocessor, Inputs, InteractiveCommand, ListDragAndDropHandler, LoadInputsPreprocessor, LoggerPreprocessor, MainArgument, MainCodeRunner, ModuleCodeRunner, ModuleCommand, MultiWriteHandle, NullConverter, NumberConverters.BigIntegerToBigDecimalConverter, NumberConverters.ByteToBigDecimalConverter, NumberConverters.ByteToBigIntegerConverter, NumberConverters.ByteToDoubleConverter, NumberConverters.ByteToFloatConverter, NumberConverters.ByteToIntegerConverter, NumberConverters.ByteToLongConverter, NumberConverters.ByteToShortConverter, NumberConverters.DoubleToBigDecimalConverter, NumberConverters.FloatToBigDecimalConverter, NumberConverters.FloatToDoubleConverter, NumberConverters.IntegerToBigDecimalConverter, NumberConverters.IntegerToBigIntegerConverter, NumberConverters.IntegerToDoubleConverter, NumberConverters.IntegerToLongConverter, NumberConverters.LongToBigDecimalConverter, NumberConverters.LongToBigIntegerConverter, NumberConverters.ShortToBigDecimalConverter, NumberConverters.ShortToBigIntegerConverter, NumberConverters.ShortToDoubleConverter, NumberConverters.ShortToFloatConverter, NumberConverters.ShortToIntegerConverter, NumberConverters.ShortToLongConverter, NumberToBigDecimalConverter, NumberToBigIntegerConverter, NumberToDoubleConverter, NumberToFloatConverter, NumberToIntegerConverter, NumberToLongConverter, NumberToNumberConverter, NumberToShortConverter, OpenArgument, OptionsPlugin, ParameterScriptProcessor, PathToFileConverter, PrimitiveArrayUnwrapper, PrimitiveArrayWrapper, ReadBufferDataHandle, RunArgument, RunArgument, RunScriptArgument, SaveInputsPreprocessor, SciJava, SciJavaApp, ScriptCodeRunner, ScriptDirectiveScriptProcessor, ScriptFileDragAndDropHandler, ScriptIOPlugin, ServicePreprocessor, ShebangScriptProcessor, ShowUIArgument, SortablePlugin, StderrLogService, StringToArrayConverter, StringToNumberConverter, SystemPropertyArgument, TextIOPlugin, UIArgument, UIPreprocessor, UnimplementedCommand, ValidityPreprocessor, WriteBufferDataHandle

public interface SciJavaPlugin

Top-level interface for plugins. Plugins discoverable at runtime must implement this interface and be annotated with @Plugin.

What all plugins have in common is that they are declared using an annotation (@Plugin), and discovered if present on the classpath at runtime.

The core types of plugins are as follows:

• App - metadata about a SciJava application.
• Command - plugins that are executable. These plugins typically perform a discrete operation, and are accessible via the application menus.
• ConsoleArgument - plugins that handle arguments passed to the application as command line parameters.
• Converter - plugins which translate objects between data types.
• Display - plugins that visualize objects, often used to display module outputs.
• IOPlugin - plugins that read or write data.
• PreprocessorPlugin - plugins that perform preprocessing on modules. A preprocessor plugin is a discoverable ModulePreprocessor.
• PostprocessorPlugin - plugins that perform postprocessing on modules. A PostprocessorPlugin is a discoverable ModulePostprocessor.
• Platform - plugins for defining platform-specific behavior.
• ScriptLanguage - plugins that enable executing scripts in particular languages as SciJava modules.
• Service - plugins that define new API in a particular area.
• Tool - plugins that map user input (e.g., keyboard and mouse actions) to behavior. They are usually rendered as icons in the application toolbar.
• InputWidget - plugins that render UI widgets for the InputHarvester preprocessor.

Author:

Curtis Rueden

See Also:

Plugin, PluginService