JIPipePluginRegistry (jipipe 5.1.0-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.api.registries.JIPipePluginRegistry

public class JIPipePluginRegistry
extends Object

Registry for managing extensions

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JIPipePluginRegistry.ScheduledActivatePluginEvent` Triggered by `JIPipePluginRegistry` when an extension is scheduled to be activated
`static class`	`JIPipePluginRegistry.ScheduledActivatePluginEventEmitter`
`static interface`	`JIPipePluginRegistry.ScheduledActivatePluginEventListener`
`static class`	`JIPipePluginRegistry.ScheduledDeactivatePluginEvent` Triggered by `JIPipePluginRegistry` when an extension is scheduled to be deactivated
`static class`	`JIPipePluginRegistry.ScheduledDeactivatePluginEventEmitter`
`static interface`	`JIPipePluginRegistry.ScheduledDeactivatePluginEventListener`
`static class`	`JIPipePluginRegistry.Settings`

Constructor Summary

Constructors
Constructor and Description

JIPipePluginRegistry(JIPipe jiPipe)

Constructors
Constructor and Description
`JIPipePluginRegistry(JIPipe jiPipe)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearSchedule(String id)`
`void`	`dismissNewPlugins()`
`void`	`findNewPlugins()` Updates the list of new extensions
`static Set<JIPipeDependency>`	`findUnsatisfiedDependencies(Set<JIPipeDependency> dependencies)` Finds all dependencies that cannot be met
`Set<String>`	`getActivatedPlugins()` List of all activated extensions
`Set<String>`	`getAllDependenciesOf(String id)` Returns the dependency IDs that are dependencies of the provided extension ID
`Set<String>`	`getAllDependentsOf(String id)` Returns the dependency IDs that are depentents of the provided extension ID
`org.jgrapht.graph.DefaultDirectedGraph<JIPipeDependency,org.jgrapht.graph.DefaultEdge>`	`getDependencyGraph()` Returns a directed graph of all dependencies.
`JIPipe`	`getJIPipe()`
`Map<String,JIPipePlugin>`	`getKnownPluginById()`
`JIPipePlugin`	`getKnownPluginById(String id)` Returns a known extension by ID If multiple extensions share the same ID, only one is returned If there is none, null will be returned
`List<JIPipePlugin>`	`getKnownPluginsList()`
`Set<String>`	`getNewPlugins()` A set of extensions that are new and should be made known to the user
`static Path`	`getPropertyFile()`
`JIPipePluginRegistry.ScheduledActivatePluginEventEmitter`	`getScheduledActivatePluginEventEmitter()`
`Set<String>`	`getScheduledActivatePlugins()`
`JIPipePluginRegistry.ScheduledDeactivatePluginEventEmitter`	`getScheduledDeactivatePluginEventEmitter()`
`Set<String>`	`getScheduledDeactivatePlugins()`
`JIPipePluginRegistry.Settings`	`getSettings()`
`void`	`initialize()`
`boolean`	`isKnownDependency(String id)`
`void`	`load()`
`void`	`load(Path file)` Loads settings from the specified file
`void`	`registerKnownPlugin(JIPipePlugin extension)` Registers an extension as known to the extension registry.
`void`	`save()` Saves the settings to the default settings file
`void`	`save(Path file)` Saves the settings to the specified file
`void`	`scheduleActivatePlugin(String id)`
`void`	`scheduleDeactivatePlugin(String id)`
`Set<JIPipeDependency>`	`tryResolveToKnownDependencies(Set<JIPipeDependency> dependencies)` Resolves as many dependencies in the provided set against a known dependency, so there is access to other metadata.
`boolean`	`willBeActivatedOnNextStartup(String id)`
`boolean`	`willBeDeactivatedOnNextStartup(String id)`

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

- Constructor Detail
  - JIPipePluginRegistry
```
public JIPipePluginRegistry(JIPipe jiPipe)
```
- Method Detail
  - findUnsatisfiedDependencies
```
public static Set<JIPipeDependency> findUnsatisfiedDependencies(Set<JIPipeDependency> dependencies)
```
    Finds all dependencies that cannot be met
    
    Parameters:
    
    dependencies - List of dependencies to be checked. Only the ID will be checked.
    
    Returns:
    
    Set of dependencies whose IDs are not registered
  - getPropertyFile
```
public static Path getPropertyFile()
```
    Returns:
    
    The location of the file where the settings are stored
  - initialize
```
public void initialize()
```
  - getSettings
```
public JIPipePluginRegistry.Settings getSettings()
```
  - getScheduledDeactivatePluginEventEmitter
```
public JIPipePluginRegistry.ScheduledDeactivatePluginEventEmitter getScheduledDeactivatePluginEventEmitter()
```
  - getScheduledActivatePluginEventEmitter
```
public JIPipePluginRegistry.ScheduledActivatePluginEventEmitter getScheduledActivatePluginEventEmitter()
```
  - getActivatedPlugins
```
public Set<String> getActivatedPlugins()
```
    List of all activated extensions
    
    Returns:
    
    unmodifiable set
  - registerKnownPlugin
```
public void registerKnownPlugin(JIPipePlugin extension)
```
    Registers an extension as known to the extension registry. Will not activate the extension
    
    Parameters:
    
    extension - the extension
  - getKnownPluginById
```
public JIPipePlugin getKnownPluginById(String id)
```
    Returns a known extension by ID If multiple extensions share the same ID, only one is returned If there is none, null will be returned
    
    Parameters:
    
    id - the ID
    
    Returns:
    
    the extension or null
  - findNewPlugins
```
public void findNewPlugins()
```
    Updates the list of new extensions
  - dismissNewPlugins
```
public void dismissNewPlugins()
```
  - getNewPlugins
```
public Set<String> getNewPlugins()
```
    A set of extensions that are new and should be made known to the user
    
    Returns:
    
    the extensions (unmodifiable)
  - getKnownPluginsList
```
public List<JIPipePlugin> getKnownPluginsList()
```
  - getKnownPluginById
```
public Map<String,JIPipePlugin> getKnownPluginById()
```
  - clearSchedule
```
public void clearSchedule(String id)
```
  - getAllDependenciesOf
```
public Set<String> getAllDependenciesOf(String id)
```
    Returns the dependency IDs that are dependencies of the provided extension ID
    
    Parameters:
    
    id - the extension id
    
    Returns:
    
    set of dependency ids
  - getAllDependentsOf
```
public Set<String> getAllDependentsOf(String id)
```
    Returns the dependency IDs that are depentents of the provided extension ID
    
    Parameters:
    
    id - the extension id
    
    Returns:
    
    set of dependency ids
  - scheduleActivatePlugin
```
public void scheduleActivatePlugin(String id)
```
  - scheduleDeactivatePlugin
```
public void scheduleDeactivatePlugin(String id)
```
  - getDependencyGraph
```
public org.jgrapht.graph.DefaultDirectedGraph<JIPipeDependency,org.jgrapht.graph.DefaultEdge> getDependencyGraph()
```
    Returns a directed graph of all dependencies. The dependencies are the sources. Might contain cycles
    
    Returns:
    
    the dependency graph
  - isKnownDependency
```
public boolean isKnownDependency(String id)
```
  - tryResolveToKnownDependencies
```
public Set<JIPipeDependency> tryResolveToKnownDependencies(Set<JIPipeDependency> dependencies)
```
    Resolves as many dependencies in the provided set against a known dependency, so there is access to other metadata. If a dependency is not known, the original object is preserved
    
    Parameters:
    
    dependencies - the dependencies
    
    Returns:
    
    set where known extensions are replacing dummy objects
  - willBeActivatedOnNextStartup
```
public boolean willBeActivatedOnNextStartup(String id)
```
  - willBeDeactivatedOnNextStartup
```
public boolean willBeDeactivatedOnNextStartup(String id)
```
  - getScheduledActivatePlugins
```
public Set<String> getScheduledActivatePlugins()
```
  - getScheduledDeactivatePlugins
```
public Set<String> getScheduledDeactivatePlugins()
```
  - save
```
public void save(Path file)
```
    Saves the settings to the specified file
    
    Parameters:
    
    file - the file path
  - save
```
public void save()
```
    Saves the settings to the default settings file
  - load
```
public void load()
```
  - load
```
public void load(Path file)
```
    Loads settings from the specified file
    
    Parameters:
    
    file - the file
  - getJIPipe
```
public JIPipe getJIPipe()
```

Class JIPipePluginRegistry

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JIPipePluginRegistry

Method Detail

findUnsatisfiedDependencies

getPropertyFile

initialize

getSettings

getScheduledDeactivatePluginEventEmitter

getScheduledActivatePluginEventEmitter

getActivatedPlugins

registerKnownPlugin

getKnownPluginById

findNewPlugins

dismissNewPlugins

getNewPlugins

getKnownPluginsList

getKnownPluginById

clearSchedule

getAllDependenciesOf

getAllDependentsOf

scheduleActivatePlugin

scheduleDeactivatePlugin

getDependencyGraph

isKnownDependency

tryResolveToKnownDependencies

willBeActivatedOnNextStartup

willBeDeactivatedOnNextStartup

getScheduledActivatePlugins

getScheduledDeactivatePlugins

save

save

load

load

getJIPipe