org.scijava.module
Interface MutableModule

All Superinterfaces:
Module, Runnable
All Known Implementing Classes:
DefaultMutableModule, DynamicCommand, 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
 void addInput(ModuleItem<?> input)
          Adds an input to the list.
<T> MutableModuleItem<T>
addInput(String name, Class<T> type)
          Adds an input to the list.
 void addOutput(ModuleItem<?> output)
          Adds an output to the list.
<T> MutableModuleItem<T>
addOutput(String name, Class<T> type)
          Adds an output to the list.
 MutableModuleInfo getInfo()
          Gets metadata about this module.
 void removeInput(ModuleItem<?> input)
          Removes an input from the list.
 void removeOutput(ModuleItem<?> output)
          Removes an output from the list.
 
Methods inherited from interface org.scijava.module.Module
cancel, getDelegateObject, getInput, getInputs, getOutput, getOutputs, initialize, isResolved, preview, setInput, setInputs, setOutput, setOutputs, setResolved
 
Methods inherited from interface java.lang.Runnable
run
 

Method Detail

addInput

<T> MutableModuleItem<T> addInput(String name,
                                  Class<T> type)
Adds an input to the list.


addInput

void addInput(ModuleItem<?> input)
Adds an input to the list.


addOutput

<T> MutableModuleItem<T> addOutput(String name,
                                   Class<T> type)
Adds an output to the list.


addOutput

void addOutput(ModuleItem<?> output)
Adds an output to the list.


removeInput

void removeInput(ModuleItem<?> input)
Removes an input from the list.


removeOutput

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


Copyright © 2009–2015 SciJava. All rights reserved.