org.scijava.plugin

Interface WrapperPlugin<D>

Type Parameters:

D - Data type wrapped by the plugin.

All Superinterfaces:

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

All Known Subinterfaces:

ButtonWidget<U>, ChoiceWidget<U>, ColorWidget<U>, DataHandle<L>, DateWidget<U>, FileWidget<U>, InputWidget<T,W>, MessageWidget<U>, NumberWidget<U>, ObjectWidget<U>, TextWidget<U>, ToggleWidget<U>

All Known Implementing Classes:

AbstractDataHandle, AbstractInputWidget, AbstractUIInputWidget, AbstractWrapperPlugin, FileHandle

public interface WrapperPlugin<D>
extends TypedPlugin<D>

A plugin with a special "has-a" relationship (i.e., composition rather than inheritance) with a single data object of a particular type.

For a concrete example, see org.scijava.widget.InputWidget.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method and Description
D	get() Gets the data object currently associated with this plugin.
void	set(D data) Associates the given data object with this plugin.

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

Method Detail

set

void set(D data)

Associates the given data object with this plugin. It must be a compatible object (i.e., Typed.supports(T) must return true).

Parameters:

data - The data object to associate with the plugin.

Throws:

IllegalArgumentException - if the data object is not compatible.

get

D get()

Gets the data object currently associated with this plugin.