Package com.inductiveautomation.ignition.common.modules

Class ModuleDependencyGraph

java.lang.Object

com.inductiveautomation.ignition.common.modules.ModuleDependencyGraph

public class ModuleDependencyGraph
extends Object

Constructor Summary

Constructors

Constructor	Description
ModuleDependencyGraph(List<ModuleInfo> modules, int scope)

Method Summary

Modifier and Type	Method	Description
ModuleDependencyGraph	detectVersionMismatch(String sourceModule)	Inspects all module dependencies for any whose versions are wrong, and throws a DependencyVersionMismatchException if any are found.
List<ModuleInfo>	findDependentModules(String moduleId)	Find a list of the modules that depend on the given module, directly or indirectly.
List<ModuleInfo>	findRequiredModules(String moduleId)	Find a list of the modules that given module requires, directly or indirectly.
List<ModuleInfo>	getInTopologicalOrder()
Collection<String>	getMissingDependencies(String moduleId)	Returns a collection of missing dependencies of this module or any of its present dependencies, or empty collection if nothing is missing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ModuleDependencyGraph

public ModuleDependencyGraph(List<ModuleInfo> modules,
 int scope)
                      throws DependencyCycleException

Throws:

DependencyCycleException

Method Details

getMissingDependencies

public Collection<String> getMissingDependencies(String moduleId)

Returns a collection of missing dependencies of this module or any of its present dependencies, or empty collection if nothing is missing.

detectVersionMismatch

public ModuleDependencyGraph detectVersionMismatch(String sourceModule)
                                            throws DependencyVersionMismatchException

Inspects all module dependencies for any whose versions are wrong, and throws a DependencyVersionMismatchException if any are found.

Returns:

this for chained invocation style

Throws:

DependencyVersionMismatchException

findDependentModules

public List<ModuleInfo> findDependentModules(String moduleId)

Find a list of the modules that depend on the given module, directly or indirectly. Order will be "topological", meaning that any module in the list may depend on modules that came before it, but not after.

findRequiredModules

public List<ModuleInfo> findRequiredModules(String moduleId)

Find a list of the modules that given module requires, directly or indirectly. Order will be "topological", meaning that any module in the list may depend on modules that came before it, but not after.

getInTopologicalOrder

public List<ModuleInfo> getInTopologicalOrder()

Returns:

A list of all modules in topological order, meaning that any module in the list may depend on modules that came before it, but not after.