Package org.scijava.module

Interface MutableModule

All Superinterfaces:

Module, Runnable

All Known Implementing Classes:

DefaultMutableModule, DynamicCommand, Inputs, InteractiveCommand, OptionsPlugin

public interface MutableModule
extends Module

Module extension allowing manipulation of its metadata.

In particular, module inputs and outputs can be added, edited and removed.

A MutableModule always has MutableModuleInfo attached to it, accessible via the getInfo() method.

Author:

Curtis Rueden

See Also:

DynamicCommand

Method Summary

Modifier and Type	Method	Description
default <T> MutableModuleItem<T>	addInput(String name, Class<T> type)	Adds an input to the list.
default void	addInput(ModuleItem<?> input)	Adds an input to the list.
default <T> MutableModuleItem<T>	addOutput(String name, Class<T> type)	Adds an output to the list.
default void	addOutput(ModuleItem<?> output)	Adds an output to the list.
MutableModuleInfo	getInfo()	Gets metadata about this module.
default void	removeInput(ModuleItem<?> input)	Removes an input from the list.
default void	removeOutput(ModuleItem<?> output)	Removes an output from the list.
default void	run()

Methods inherited from interface org.scijava.module.Module

cancel, getDelegateObject, getInput, getInputs, getOutput, getOutputs, initialize, isInputResolved, isOutputResolved, isResolved, preview, resolveInput, resolveOutput, setInput, setInputs, setOutput, setOutputs, setResolved, unresolveInput, unresolveOutput

Method Detail

addInput

default <T> MutableModuleItem<T> addInput(String name,
                                          Class<T> type)

Adds an input to the list.

addInput

default void addInput(ModuleItem<?> input)

Adds an input to the list.

addOutput

default <T> MutableModuleItem<T> addOutput(String name,
                                           Class<T> type)

Adds an output to the list.

addOutput

default void addOutput(ModuleItem<?> output)

Adds an output to the list.

removeInput

default void removeInput(ModuleItem<?> input)

Removes an input from the list.

removeOutput

default void removeOutput(ModuleItem<?> output)

Removes an output from the list.

getInfo

MutableModuleInfo getInfo()

Description copied from interface: Module

Gets metadata about this module.

Specified by:

getInfo in interface Module

run

default void run()

Specified by:

run in interface Runnable