org.eclipse.e4.ui.internal.workbench

Class ExtensionsSort

java.lang.Object

org.eclipse.e4.ui.internal.workbench.TopologicalSort<IExtension,Bundle>

org.eclipse.e4.ui.internal.workbench.ExtensionsSort

public class ExtensionsSort
extends TopologicalSort<IExtension,Bundle>

Sort IExtensions by their plug-in dependencies such that any extension from bundle A should be sorted before any extensions from any bundles that depend on A.

Consider having extensions from bundles A, B, and C, where A depends on B, and B depends on C. The result of this sort should be the extensions from C, then from B, and finally from A.

Constructor Summary

Constructors

Constructor and Description
ExtensionsSort()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<Bundle>	getDependencies(Bundle bundle) Returns the bundles that currently require the given bundle.
protected Bundle	getId(IExtension extension) Return the identifier for the given object.
protected java.util.Collection<Bundle>	getRequirements(Bundle bundle) Returns the bundles that the given bundle requires.

Methods inherited from class org.eclipse.e4.ui.internal.workbench.TopologicalSort

sort

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionsSort

public ExtensionsSort()

Method Detail

getId

protected Bundle getId(IExtension extension)

Description copied from class: TopologicalSort

Return the identifier for the given object. The implementation properly tracks where multiple objects have the same identifier.

Specified by:

getId in class TopologicalSort<IExtension,Bundle>

Parameters:

extension - the object

Returns:

the identifier

getRequirements

protected java.util.Collection<Bundle> getRequirements(Bundle bundle)

Returns the bundles that the given bundle requires.

Specified by:

getRequirements in class TopologicalSort<IExtension,Bundle>

Parameters:

bundle - the id

Returns:

An unmodifiable Iterable set of bundles currently required by the geiven bundle. An empty Iterable will be returned if the given Bundle object has become stale or there are no bundles required.

Throws:

java.lang.NullPointerException - if bundle is null

getDependencies

protected java.util.Collection<Bundle> getDependencies(Bundle bundle)

Returns the bundles that currently require the given bundle.

If bundle is required and then re-exported by another bundle then all the requiring bundles of the re-exporting bundle are included in the returned array as they transitively depend on bundle.

Specified by:

getDependencies in class TopologicalSort<IExtension,Bundle>

Parameters:

bundle - the id

Returns:

An unmodifiable Iterable set of bundles currently requiring bundle. An empty Iterable will be returned if the bundle has become stale or has no dependents.

Throws:

java.lang.NullPointerException - if bundle is null