Package org.scijava.module

Interface MutableModuleInfo

All Superinterfaces:

BasicDetails, Comparable<Prioritized>, Identifiable, Locatable, ModuleInfo, Named, Prioritized, UIDetails, Validated, Versioned

All Known Implementing Classes:

DefaultMutableModuleInfo, DynamicCommandInfo

public interface MutableModuleInfo
extends ModuleInfo

ModuleInfo extension allowing manipulation of its metadata.

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

Note that a MutableModuleInfo does not necessarily have MutableModuleItems!

Author:

Curtis Rueden

See Also:

DynamicCommand

Field Summary

Fields inherited from interface org.scijava.UIDetails

APPLICATION_MENU_ROOT

Method Summary

Modifier and Type	Method	Description
void	addInput(ModuleItem<?> input)	Adds an input to the list.
void	addOutput(ModuleItem<?> output)	Adds an output to the list.
default Module	createModule()	Instantiates the module described by this module info.
default String	getDelegateClassName()	Gets the fully qualified name of the class containing the module's actual implementation.
Class<? extends Module>	getModuleClass()	Gets the module class described by this ModuleInfo.
default Class<?>	loadDelegateClass()	Loads the class containing the module's actual implementation.
void	removeInput(ModuleItem<?> input)	Removes an input from the list.
void	removeOutput(ModuleItem<?> output)	Removes an output from the list.
void	setModuleClass(Class<? extends Module> moduleClass)	Sets the module class described by this ModuleInfo.

Methods inherited from interface org.scijava.BasicDetails

get, getDescription, getLabel, is, set, setDescription, setLabel

Methods inherited from interface org.scijava.module.ModuleInfo

canCancel, canPreview, canRunHeadless, getIdentifier, getInitializer, getInput, getInput, getLocation, getOutput, getOutput, getProblems, getTitle, getVersion, inputs, isInteractive, isValid, outputs, update

Methods inherited from interface org.scijava.Named

getName, setName

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface org.scijava.UIDetails

compareTo, getIconPath, getMenuPath, getMenuRoot, getSelectionGroup, isEnabled, isSelectable, isSelected, isVisible, setEnabled, setIconPath, setMenuPath, setMenuRoot, setSelectable, setSelected, setSelectionGroup, setVisible

Method Detail

setModuleClass

void setModuleClass(Class<? extends Module> moduleClass)

Sets the module class described by this ModuleInfo.

getModuleClass

Class<? extends Module> getModuleClass()

Gets the module class described by this ModuleInfo.

addInput

void addInput(ModuleItem<?> input)

Adds an input 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.

getDelegateClassName

default String getDelegateClassName()

Description copied from interface: ModuleInfo

Gets the fully qualified name of the class containing the module's actual implementation. By definition, this is the same value returned by createModule().getDelegateObject().getClass().getName(), and hence is also the class containing any callback methods specified by ModuleItem.getCallback().

The nature of this method is implementation-specific; for example, a CommandModule will return the class name of its associated Command. For modules that are not commands, the result may be something else.

If you are implementing this interface directly, a good rule of thumb is to return the class name of the associated Module (i.e., the same value given by createModule().getClass().getName()).

Specified by:

getDelegateClassName in interface ModuleInfo

loadDelegateClass

default Class<?> loadDelegateClass()

Description copied from interface: ModuleInfo

Loads the class containing the module's actual implementation. The name of the loaded class will match the value returned by ModuleInfo.getDelegateClassName().

Specified by:

loadDelegateClass in interface ModuleInfo

See Also:

Instantiable.loadClass()

createModule

default Module createModule()
                     throws ModuleException

Description copied from interface: ModuleInfo

Instantiates the module described by this module info.

Specified by:

createModule in interface ModuleInfo

Throws:

ModuleException