org.scijava.plugin

Interface HandlerPlugin<D>

Type Parameters:

D - Data type associated with the plugin.

All Superinterfaces:

Comparable<Prioritized>, Contextual, HasPluginInfo, Prioritized, RichPlugin, SciJavaPlugin, SingletonPlugin, Typed<D>, TypedPlugin<D>

All Known Subinterfaces:

ConsoleArgument, Converter<I,O>, DragAndDropHandler<D>, IOPlugin<D>, ScriptHeader, TextFormat

All Known Implementing Classes:

AbstractConsoleArgument, AbstractConverter, AbstractDragAndDropHandler, AbstractHandlerPlugin, AbstractIOPlugin, AbstractScriptHeader, AbstractTextFormat, 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, DefaultConverter, FileDragAndDropHandler, ListDragAndDropHandler, NullConverter, OpenArgument, PrimitiveArrayUnwrapper, PrimitiveArrayWrapper, RunArgument, ScriptFileDragAndDropHandler, ScriptIOPlugin, SystemPropertyArgument, TextIOPlugin, UIArgument

public interface HandlerPlugin<D>
extends SingletonPlugin, TypedPlugin<D>

Interface for plugins which "handle" a particular subset of data objects. A handler plugin is a SingletonPlugin associated with a specific data type (i.e., implementing TypedPlugin).

For a given data object (of type D), the HandlerPlugin declares whether it can handle that data object via the Typed.supports(T) method. The plugin's associated HandlerService.getHandler(DT) method then uses this capability to determine the most appropriate handler for any given data object.

Note that there is no single handle(D) method for actually handling data objects, because it would be rather inflexible; e.g., handlers may have other required inputs, or may provide more than one possible avenue of handling (i.e., more than one "handle"-style method).

Author:

Curtis Rueden

See Also:

HandlerService

Method Summary

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Typed

getType, supports