ModuleInfo (SciJava Common 2.88.2 API)

All Superinterfaces:

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

All Known Subinterfaces:

MutableModuleInfo

All Known Implementing Classes:

AbstractModuleInfo, CommandInfo, DefaultMutableModuleInfo, DynamicCommandInfo, ScriptInfo
```
public interface ModuleInfo
extends UIDetails, Validated, Identifiable, Locatable, Versioned
```
A ModuleInfo object encapsulates metadata about a particular Module (but not a specific instance of it). In particular, it can report details on the names and types of inputs and outputs.
A special class of implicit input parameters is available: when the name starts with a dot (e.g. .helloWorld), no warning is issued about an unmatched input.

Author:

Aivar Grislis, Curtis Rueden

Field Summary
- Fields inherited from interface org.scijava.UIDetails
  APPLICATION_MENU_ROOT

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`canCancel()` Gets whether the module condones cancellation.
`default boolean`	`canPreview()` Gets whether the module supports previews.
`default boolean`	`canRunHeadless()` Gets whether the module condones headless execution.
`Module`	`createModule()` Instantiates the module described by this module info.
`String`	`getDelegateClassName()` Gets the fully qualified name of the class containing the module's actual implementation.
`default String`	`getIdentifier()` Gets a string intended to function as an identifier for the object.
`default String`	`getInitializer()` Gets the function that is called to initialize the module's values.
`ModuleItem<?>`	`getInput(String name)` Gets the input item with the given name.
`<T> ModuleItem<T>`	`getInput(String name, Class<T> type)` Gets the input item with the given name and type.
`default String`	`getLocation()` Gets the URL string defining the object's location.
`ModuleItem<?>`	`getOutput(String name)` Gets the output item with the given name.
`<T> ModuleItem<T>`	`getOutput(String name, Class<T> type)` Gets the output item with the given name and type.
`default List<ValidityProblem>`	`getProblems()` Gets the list of problems encountered while initializing the object.
`default String`	`getTitle()` Gets an appropriate title for the object, for use in a user interface.
`default String`	`getVersion()` Gets the version of the object.
`Iterable<ModuleItem<?>>`	`inputs()` Gets the list of input items.
`default boolean`	`isInteractive()` Gets whether the module is intended to be run interactively.
`default boolean`	`isValid()` Gets whether the object is completely valid (i.e., no problems during initialization).
`Class<?>`	`loadDelegateClass()` Loads the class containing the module's actual implementation.
`Iterable<ModuleItem<?>>`	`outputs()` Gets the list of output items.
`default void`	`update(EventService eventService)` Notifies interested parties that the module info has been modified.

Methods inherited from interface org.scijava.UIDetails
compareTo, getIconPath, getMenuPath, getMenuRoot, getSelectionGroup, isEnabled, isSelectable, isSelected, isVisible, setEnabled, setIconPath, setMenuPath, setMenuRoot, setSelectable, setSelected, setSelectionGroup, setVisible

Methods inherited from interface org.scijava.BasicDetails
get, getDescription, getLabel, is, set, setDescription, setLabel

Methods inherited from interface org.scijava.Named
getName, setName

Methods inherited from interface org.scijava.Prioritized
getPriority, setPriority

- Method Detail
  - getInput
```
ModuleItem<?> getInput(String name)
```
    Gets the input item with the given name.
  - getInput
```
<T> ModuleItem<T> getInput(String name,
                           Class<T> type)
```
    Gets the input item with the given name and type.
    
    Throws:
    
    IllegalArgumentException - if the given type is incompatible with the named input item
  - getOutput
```
ModuleItem<?> getOutput(String name)
```
    Gets the output item with the given name.
  - getOutput
```
<T> ModuleItem<T> getOutput(String name,
                            Class<T> type)
```
    Gets the output item with the given name and type.
    
    Throws:
    
    IllegalArgumentException - if the given type is incompatible with the named output item
  - inputs
```
Iterable<ModuleItem<?>> inputs()
```
    Gets the list of input items.
  - outputs
```
Iterable<ModuleItem<?>> outputs()
```
    Gets the list of output items.
  - getDelegateClassName
```
String getDelegateClassName()
```
    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()).
  - loadDelegateClass
```
Class<?> loadDelegateClass()
                    throws ClassNotFoundException
```
    Loads the class containing the module's actual implementation. The name of the loaded class will match the value returned by getDelegateClassName().
    
    Throws:
    
    ClassNotFoundException
    
    See Also:
    
    Instantiable.loadClass()
  - createModule
```
Module createModule()
             throws ModuleException
```
    Instantiates the module described by this module info.
    
    Throws:
    
    ModuleException
  - isInteractive
```
default boolean isInteractive()
```
    Gets whether the module is intended to be run interactively. Typically this means its inputs are supposed to be presented in a non-modal dialog box, with Runnable.run() being called whenever any of the values change.
  - canPreview
```
default boolean canPreview()
```
    Gets whether the module supports previews. A preview is a quick approximation of the results that would be obtained by actually executing the module with Runnable.run(). If this method returns false, then calling Module.preview() will have no effect.
  - canCancel
```
default boolean canCancel()
```
    Gets whether the module condones cancellation. Strictly speaking, any module execution can be canceled during preprocessing, but this flag is a hint that doing so may be a bad idea, and the UI may want to disallow it. If this method returns false, then calling Module.cancel() will have no effect.
  - canRunHeadless
```
default boolean canRunHeadless()
```
    Gets whether the module condones headless execution. Strictly speaking, there is no guarantee that any module will work headless just because it declares itself so, but this flag hints that headless execution is likely to succeed (if flag is true), or fail (if flag is false).
  - getInitializer
```
default String getInitializer()
```
    Gets the function that is called to initialize the module's values.
  - update
```
default void update(EventService eventService)
```
    Notifies interested parties that the module info has been modified. This mechanism is useful for updating any corresponding user interface such as menu items that are linked to the module.
  - getTitle
```
default String getTitle()
```
    Description copied from interface: UIDetails
    Gets an appropriate title for the object, for use in a user interface. The result is prioritized as follows:
    1. Item label
    2. Menu path's leaf entry name
    3. Item name
    4. Item's class name, without package prefix
    Specified by:
    
    getTitle in interface UIDetails
  - isValid
```
default boolean isValid()
```
    Description copied from interface: Validated
    
    Gets whether the object is completely valid (i.e., no problems during initialization).
    
    Specified by:
    
    isValid in interface Validated
  - getProblems
```
default List<ValidityProblem> getProblems()
```
    Description copied from interface: Validated
    
    Gets the list of problems encountered while initializing the object.
    
    Specified by:
    
    getProblems in interface Validated
    
    Returns:
    
    The list of problems, or a zero-length list in the case of Validated.isValid() returning true.
  - getIdentifier
```
default String getIdentifier()
```
    Description copied from interface: Identifiable
    
    Gets a string intended to function as an identifier for the object.
    
    Specified by:
    
    getIdentifier in interface Identifiable
  - getLocation
```
default String getLocation()
```
    Description copied from interface: Locatable
    
    Gets the URL string defining the object's location.
    
    Specified by:
    
    getLocation in interface Locatable
  - getVersion
```
default String getVersion()
```
    Description copied from interface: Versioned
    
    Gets the version of the object.
    
    Specified by:
    
    getVersion in interface Versioned

Interface ModuleInfo

Field Summary

Fields inherited from interface org.scijava.UIDetails

Method Summary

Methods inherited from interface org.scijava.UIDetails

Methods inherited from interface org.scijava.BasicDetails

Methods inherited from interface org.scijava.Named

Methods inherited from interface org.scijava.Prioritized

Method Detail

getInput

getInput

getOutput

getOutput

inputs

outputs

getDelegateClassName

loadDelegateClass

createModule

isInteractive

canPreview

canCancel

canRunHeadless

getInitializer

update

getTitle

isValid

getProblems

getIdentifier

getLocation

getVersion