PlugInBundle (MIPAV API Documentation)

java.lang.Object
- gov.nih.mipav.plugins.PlugInBundle

All Implemented Interfaces:

PlugIn
```
public abstract class PlugInBundle
extends java.lang.Object
implements PlugIn
```
An abstract class for a plugin which reports other available plugins bundled inside of it. These plugins are then shown individually under the plugin menu and started by this plugin. Any PlugInBundle subclass should override the getBundledPlugIns() method

Author:

mccreedy

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String[] CATEGORY
- Fields inherited from interface gov.nih.mipav.plugins.PlugIn
  Category

Constructor Summary

Constructors
Constructor Description

PlugInBundle()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Vector<BundledPlugInInfo>`	`getBundledPlugIns()`	Subclasses should override this method to return the list of plugins that they encompass.
`abstract void`	`run(int pluginIndex)`	Runs the plugin whose name is given by the location in the vector returned by `getBundledPlugIns()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CATEGORY
```
public static final java.lang.String[] CATEGORY
```
- Constructor Detail
  - PlugInBundle
```
public PlugInBundle()
```
- Method Detail
  - getBundledPlugIns
```
public java.util.Vector<BundledPlugInInfo> getBundledPlugIns()
```
    Subclasses should override this method to return the list of plugins that they encompass.
    
    Returns:
    
    A list of plugins that are bundled by this class.
  - run
```
public abstract void run(int pluginIndex)
```
    Runs the plugin whose name is given by the location in the vector returned by getBundledPlugIns().
    
    Parameters:
    
    pluginIndex - the index of the vector returned by getBundledPlugIns()