Package org.eclipse.aether.util.graph.manager

Class AbstractDependencyManager

java.lang.Object

org.eclipse.aether.util.graph.manager.AbstractDependencyManager

All Implemented Interfaces:

DependencyManager

Direct Known Subclasses:

ClassicDependencyManager, DefaultDependencyManager, TransitiveDependencyManager

public abstract class AbstractDependencyManager
extends Object
implements DependencyManager

A dependency manager support class.

This implementation is Maven specific, as it works hand-in-hand along with Maven ModelBuilder. While model builder handles dependency management in the context of single POM (inheritance, imports, etc.), this implementation carries in-lineage modifications based on previously recorded dependency management rules sourced from ascendants while building the dependency graph. Root sourced management rules are special, in a way they are always applied, while en-route collected ones are carefully applied to proper descendants only, to not override work done by model builder already.

Details: Model builder handles version, scope from own dependency management (think "effective POM"). On the other hand it does not handle optional for example. System paths are aligned across whole graph, making sure there is same system path used by same dependency. Finally, exclusions (exclusions are additional information not effective or applied in same POM) are always applied. This implementation makes sure, that version and scope are not applied onto same node that actually provided the rules, to no override work that ModelBuilder did. It achieves this goal by tracking "depth" for each collected rule and ignoring rules coming from same depth as processed dependency node is.

Note for future: the field managedLocalPaths is intentionally left out of hash/equals, with reason explained above.

Implementation note for all managers extending this class: this class maintains "path" (list of parent managers) and "depth". Depth 0 is basically used as "factory" on session; is the instance created during session creation and is usually empty (just parameterized). Depth 1 is the current collection "root", depth 2 are direct dependencies, depth 3 first level of transitive dependencies of direct dependencies and so on. Hence, on depth 1 (the collection root, initialized with management possibly as well) parent will be always the empty "factory" instance, and we need special handling: "apply onto itself". This does not stand on depth > 1.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractDependencyManager.Holder<T>	Wrapper class for collection to memoize hash code.
protected static class	AbstractDependencyManager.Key

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	applyFrom
protected final int	depth
protected final int	deriveUntil
protected final MMap<AbstractDependencyManager.Key,AbstractDependencyManager.Holder<Collection<Exclusion>>>	managedExclusions
protected final MMap<AbstractDependencyManager.Key,String>	managedLocalPaths
protected final MMap<AbstractDependencyManager.Key,Boolean>	managedOptionals
protected final MMap<AbstractDependencyManager.Key,String>	managedScopes
protected final MMap<AbstractDependencyManager.Key,String>	managedVersions
protected final ArrayList<AbstractDependencyManager>	path
protected final SystemDependencyScope	systemDependencyScope

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDependencyManager(int deriveUntil, int applyFrom, ScopeManager scopeManager)
protected	AbstractDependencyManager(ArrayList<AbstractDependencyManager> path, int depth, int deriveUntil, int applyFrom, MMap<AbstractDependencyManager.Key,String> managedVersions, MMap<AbstractDependencyManager.Key,String> managedScopes, MMap<AbstractDependencyManager.Key,Boolean> managedOptionals, MMap<AbstractDependencyManager.Key,String> managedLocalPaths, MMap<AbstractDependencyManager.Key,AbstractDependencyManager.Holder<Collection<Exclusion>>> managedExclusions, SystemDependencyScope systemDependencyScope)

Method Summary

Modifier and Type	Method	Description
DependencyManager	deriveChildManager(DependencyCollectionContext context)	Derives a dependency manager for the specified collection context.
boolean	equals(Object obj)
int	hashCode()
protected boolean	isApplied()	Returns true if current dependency should be managed according to so far collected/derived rules.
protected boolean	isDerived()	Returns true if current context should be factored in (collected/derived).
DependencyManagement	manageDependency(Dependency dependency)	Applies dependency management to the specified dependency.
protected abstract DependencyManager	newInstance(MMap<AbstractDependencyManager.Key,String> managedVersions, MMap<AbstractDependencyManager.Key,String> managedScopes, MMap<AbstractDependencyManager.Key,Boolean> managedOptionals, MMap<AbstractDependencyManager.Key,String> managedLocalPaths, MMap<AbstractDependencyManager.Key,AbstractDependencyManager.Holder<Collection<Exclusion>>> managedExclusions)

Methods inherited from class java.lang.Object

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

Field Details

path

protected final ArrayList<AbstractDependencyManager> path

depth

protected final int depth

deriveUntil

protected final int deriveUntil

applyFrom

protected final int applyFrom

managedVersions

protected final MMap<AbstractDependencyManager.Key,String> managedVersions

managedScopes

protected final MMap<AbstractDependencyManager.Key,String> managedScopes

managedOptionals

protected final MMap<AbstractDependencyManager.Key,Boolean> managedOptionals

managedLocalPaths

protected final MMap<AbstractDependencyManager.Key,String> managedLocalPaths

managedExclusions

protected final MMap<AbstractDependencyManager.Key,AbstractDependencyManager.Holder<Collection<Exclusion>>> managedExclusions

systemDependencyScope

protected final SystemDependencyScope systemDependencyScope

Constructor Details

AbstractDependencyManager

protected AbstractDependencyManager(int deriveUntil,
 int applyFrom,
 ScopeManager scopeManager)

AbstractDependencyManager

protected AbstractDependencyManager(ArrayList<AbstractDependencyManager> path,
 int depth,
 int deriveUntil,
 int applyFrom,
 MMap<AbstractDependencyManager.Key,String> managedVersions,
 MMap<AbstractDependencyManager.Key,String> managedScopes,
 MMap<AbstractDependencyManager.Key,Boolean> managedOptionals,
 MMap<AbstractDependencyManager.Key,String> managedLocalPaths,
 MMap<AbstractDependencyManager.Key,AbstractDependencyManager.Holder<Collection<Exclusion>>> managedExclusions,
 SystemDependencyScope systemDependencyScope)

Method Details

newInstance

protected abstract DependencyManager newInstance(MMap<AbstractDependencyManager.Key,String> managedVersions,
 MMap<AbstractDependencyManager.Key,String> managedScopes,
 MMap<AbstractDependencyManager.Key,Boolean> managedOptionals,
 MMap<AbstractDependencyManager.Key,String> managedLocalPaths,
 MMap<AbstractDependencyManager.Key,AbstractDependencyManager.Holder<Collection<Exclusion>>> managedExclusions)

deriveChildManager

public DependencyManager deriveChildManager(DependencyCollectionContext context)

Description copied from interface: DependencyManager

Derives a dependency manager for the specified collection context. When calculating the child manager, implementors are strongly advised to simply return the current instance if nothing changed to help save memory.

Specified by:

deriveChildManager in interface DependencyManager

Parameters:

context - The dependency collection context, must not be null.

Returns:

The dependency manager for the dependencies of the target node or null if dependency management should no longer be applied.

manageDependency

public DependencyManagement manageDependency(Dependency dependency)

Description copied from interface: DependencyManager

Applies dependency management to the specified dependency.

Specified by:

manageDependency in interface DependencyManager

Parameters:

dependency - The dependency to manage, must not be null.

Returns:

The management update to apply to the dependency or null if the dependency is not managed at all.

isDerived

protected boolean isDerived()

Returns true if current context should be factored in (collected/derived).

isApplied

protected boolean isApplied()

Returns true if current dependency should be managed according to so far collected/derived rules.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object