JIPipeExtensionRegistry (jipipe 1.76.1-SNAPSHOT API)

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

public class JIPipeExtensionRegistry
extends Object

Registry for managing extensions

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JIPipeExtensionRegistry.ScheduledActivateExtension` Triggered by `JIPipeExtensionRegistry` when an extension is scheduled to be activated
`static class`	`JIPipeExtensionRegistry.ScheduledDeactivateExtension` Triggered by `JIPipeExtensionRegistry` when an extension is scheduled to be deactivated
`static class`	`JIPipeExtensionRegistry.Settings`

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`STANDARD_EXTENSIONS` Standard set of extension IDs (1.74.0+)
`static String[]`	`STANDARD_EXTENSIONS_LEGACY` Standard set of extension IDs (for users updating from 1.73.x or older)

Constructor Summary

Constructors
Constructor and Description

JIPipeExtensionRegistry(JIPipe jiPipe)

Constructors
Constructor and Description
`JIPipeExtensionRegistry(JIPipe jiPipe)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearSchedule(String id)`
`void`	`dismissNewExtensions()`
`void`	`findNewExtensions()` Updates the list of new extensions
`static Set<JIPipeDependency>`	`findUnsatisfiedDependencies(Set<JIPipeDependency> dependencies)` Finds all dependencies that cannot be met
`Set<String>`	`getActivatedExtensions()` 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.
`EventBus`	`getEventBus()`
`JIPipe`	`getJIPipe()`
`JIPipeExtension`	`getKnownExtensionById(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
`Map<String,JIPipeExtension>`	`getKnownExtensionsById()`
`List<JIPipeExtension>`	`getKnownExtensionsList()`
`Set<String>`	`getNewExtensions()` A set of extensions that are new and should be made known to the user
`static Path`	`getPropertyFile()`
`Set<String>`	`getScheduledActivateExtensions()`
`Set<String>`	`getScheduledDeactivateExtensions()`
`Set<String>`	`getStartupExtensions()` List of all extensions that are requested during startup Please note that this may not contain core extensions Use getActivatedExtensions() instead
`void`	`initialize()`
`boolean`	`isKnownDependency(String id)`
`static boolean`	`isLegacy()`
`void`	`load()`
`void`	`load(Path file)` Loads settings from the specified file
`void`	`registerKnownExtension(JIPipeExtension 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`	`scheduleActivateExtension(String id)`
`void`	`scheduleDeactivateExtension(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

- Field Detail
  - STANDARD_EXTENSIONS
```
public static final String[] STANDARD_EXTENSIONS
```
    Standard set of extension IDs (1.74.0+)
  - STANDARD_EXTENSIONS_LEGACY
```
public static final String[] STANDARD_EXTENSIONS_LEGACY
```
    Standard set of extension IDs (for users updating from 1.73.x or older)
- Constructor Detail
  - JIPipeExtensionRegistry
```
public JIPipeExtensionRegistry(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
  - isLegacy
```
public static boolean isLegacy()
```
  - getPropertyFile
```
public static Path getPropertyFile()
```
    Returns:
    
    The location of the file where the settings are stored
  - initialize
```
public void initialize()
```
  - getStartupExtensions
```
public Set<String> getStartupExtensions()
```
    List of all extensions that are requested during startup Please note that this may not contain core extensions Use getActivatedExtensions() instead
    
    Returns:
    
    unmodifiable set
  - getActivatedExtensions
```
public Set<String> getActivatedExtensions()
```
    List of all activated extensions
    
    Returns:
    
    unmodifiable set
  - registerKnownExtension
```
public void registerKnownExtension(JIPipeExtension extension)
```
    Registers an extension as known to the extension registry. Will not activate the extension
    
    Parameters:
    
    extension - the extension
  - getKnownExtensionById
```
public JIPipeExtension getKnownExtensionById(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
  - findNewExtensions
```
public void findNewExtensions()
```
    Updates the list of new extensions
  - dismissNewExtensions
```
public void dismissNewExtensions()
```
  - getNewExtensions
```
public Set<String> getNewExtensions()
```
    A set of extensions that are new and should be made known to the user
    
    Returns:
    
    the extensions (unmodifiable)
  - getKnownExtensionsList
```
public List<JIPipeExtension> getKnownExtensionsList()
```
  - getKnownExtensionsById
```
public Map<String,JIPipeExtension> getKnownExtensionsById()
```
  - 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
  - scheduleActivateExtension
```
public void scheduleActivateExtension(String id)
```
  - scheduleDeactivateExtension
```
public void scheduleDeactivateExtension(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)
```
  - getScheduledActivateExtensions
```
public Set<String> getScheduledActivateExtensions()
```
  - getScheduledDeactivateExtensions
```
public Set<String> getScheduledDeactivateExtensions()
```
  - 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()
```
  - getEventBus
```
public EventBus getEventBus()
```

Class JIPipeExtensionRegistry

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STANDARD_EXTENSIONS

STANDARD_EXTENSIONS_LEGACY

Constructor Detail

JIPipeExtensionRegistry

Method Detail

findUnsatisfiedDependencies

isLegacy

getPropertyFile

initialize

getStartupExtensions

getActivatedExtensions

registerKnownExtension

getKnownExtensionById

findNewExtensions

dismissNewExtensions

getNewExtensions

getKnownExtensionsList

getKnownExtensionsById

clearSchedule

getAllDependenciesOf

getAllDependentsOf

scheduleActivateExtension

scheduleDeactivateExtension

getDependencyGraph

isKnownDependency

tryResolveToKnownDependencies

willBeActivatedOnNextStartup

willBeDeactivatedOnNextStartup

getScheduledActivateExtensions

getScheduledDeactivateExtensions

save

save

load

load

getJIPipe

getEventBus