Package org.eclipse.aether.internal.impl.scope

Class ScopeManagerImpl

java.lang.Object

org.eclipse.aether.internal.impl.scope.ScopeManagerImpl

All Implemented Interfaces:

InternalScopeManager, ScopeManager

public final class ScopeManagerImpl
extends Object
implements InternalScopeManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.aether.impl.scope.InternalScopeManager

InternalScopeManager.Mode

Constructor Summary

Constructors

Constructor	Description
ScopeManagerImpl(ScopeManagerConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
DependencyScope	createDependencyScope(String id, boolean transitive, Collection<BuildScopeQuery> presence)	Creates dependency scope instance.
ResolutionScope	createResolutionScope(String id, InternalScopeManager.Mode mode, Collection<BuildScopeQuery> wantedPresence, Collection<DependencyScope> explicitlyIncluded, Collection<DependencyScope> transitivelyExcluded)	Creates resolution scope instance.
SystemDependencyScope	createSystemDependencyScope(String id, boolean transitive, Collection<BuildScopeQuery> presence, String systemPathProperty)	Creates system dependency scope instance.
boolean	equals(Object o)
DependencyFilter	getDependencyFilter(ResolutionScope resolutionScope)	Resolver specific: dependency filter to be used to support this scope (with its dependency and resolution scopes).
DependencyGraphTransformer	getDependencyGraphTransformer(ResolutionScope resolutionScope)	Resolver specific: dependency graph transformer to be used to support this scope (with its dependency and resolution scopes).
Optional<DependencyScope>	getDependencyScope(String id)	Returns a specific dependency scope by label.
Optional<BuildScope>	getDependencyScopeMainProjectBuildScope(DependencyScope dependencyScope)	Returns the BuildScope that this scope deem as main.
Collection<DependencyScope>	getDependencyScopeUniverse()	Returns the "universe" (all) of dependency scopes as immutable collection.
int	getDependencyScopeWidth(DependencyScope dependencyScope)	The "width" of scope: is basically sum of all distinct ProjectPath and BuildPath that are in build scopes the scope is present in.
DependencySelector	getDependencySelector(ResolutionScope resolutionScope)	Resolver specific: dependency selector to be used to support this scope (with its dependency and resolution scopes).
String	getId()	The label.
Optional<ResolutionScope>	getResolutionScope(String id)	Returns a specific resolution scope by label.
Collection<ResolutionScope>	getResolutionScopeUniverse()	Returns the "universe" (all) of resolution scopes as immutable collection.
Optional<SystemDependencyScope>	getSystemDependencyScope()	Returns the "system" scope, if exists.
int	hashCode()
CollectResult	postProcess(ResolutionScope resolutionScope, CollectResult collectResult)	Resolver specific: post-processing to be used to support this scope (with its dependency and resolution scopes).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ScopeManagerImpl

public ScopeManagerImpl(ScopeManagerConfiguration configuration)

Method Details

getId

public String getId()

Description copied from interface: ScopeManager

The label.

Specified by:

getId in interface ScopeManager

getSystemDependencyScope

public Optional<SystemDependencyScope> getSystemDependencyScope()

Description copied from interface: ScopeManager

Returns the "system" scope, if exists.

This is a special scope. In this scope case, Resolver should handle it specially, as it has no POM (so is always a leaf on graph), is not in any repository, but is actually hosted on host OS file system. On resolution resolver merely checks is file present or not.

Specified by:

getSystemDependencyScope in interface ScopeManager

getDependencyScope

public Optional<DependencyScope> getDependencyScope(String id)

Description copied from interface: ScopeManager

Returns a specific dependency scope by label.

Note: despite returns optional, this method may throw as well, if manager set in "strict" mode.

Specified by:

getDependencyScope in interface ScopeManager

getDependencyScopeUniverse

public Collection<DependencyScope> getDependencyScopeUniverse()

Description copied from interface: ScopeManager

Returns the "universe" (all) of dependency scopes as immutable collection.

Specified by:

getDependencyScopeUniverse in interface ScopeManager

getResolutionScope

public Optional<ResolutionScope> getResolutionScope(String id)

Description copied from interface: ScopeManager

Returns a specific resolution scope by label.

Note: despite returns optional, this method may throw as well, if manager set in "strict" mode.

Specified by:

getResolutionScope in interface ScopeManager

getResolutionScopeUniverse

public Collection<ResolutionScope> getResolutionScopeUniverse()

Description copied from interface: ScopeManager

Returns the "universe" (all) of resolution scopes as immutable collection.

Specified by:

getResolutionScopeUniverse in interface ScopeManager

getDependencyScopeWidth

public int getDependencyScopeWidth(DependencyScope dependencyScope)

Description copied from interface: InternalScopeManager

The "width" of scope: is basically sum of all distinct ProjectPath and BuildPath that are in build scopes the scope is present in. The more of them, the "wider" is the scope. Transitive scopes are weighted more as well.

The ProjectPath.order() makes given path "weigh" more. So a scope being present only in "main" project path is wider than scope being present only in "test" project path.

Interpretation: the bigger the returned integer is, the "wider" the scope is. The numbers should not serve any other purposes, merely to sort scope instances by "width" (i.e. from "widest" to "narrowest").

Specified by:

getDependencyScopeWidth in interface InternalScopeManager

getDependencyScopeMainProjectBuildScope

public Optional<BuildScope> getDependencyScopeMainProjectBuildScope(DependencyScope dependencyScope)

Description copied from interface: InternalScopeManager

Returns the BuildScope that this scope deem as main.

Specified by:

getDependencyScopeMainProjectBuildScope in interface InternalScopeManager

getDependencySelector

public DependencySelector getDependencySelector(ResolutionScope resolutionScope)

Description copied from interface: InternalScopeManager

Resolver specific: dependency selector to be used to support this scope (with its dependency and resolution scopes).

Specified by:

getDependencySelector in interface InternalScopeManager

getDependencyGraphTransformer

public DependencyGraphTransformer getDependencyGraphTransformer(ResolutionScope resolutionScope)

Description copied from interface: InternalScopeManager

Resolver specific: dependency graph transformer to be used to support this scope (with its dependency and resolution scopes).

Specified by:

getDependencyGraphTransformer in interface InternalScopeManager

postProcess

public CollectResult postProcess(ResolutionScope resolutionScope,
 CollectResult collectResult)

Description copied from interface: InternalScopeManager

Resolver specific: post-processing to be used to support this scope (with its dependency and resolution scopes).

Specified by:

postProcess in interface InternalScopeManager

getDependencyFilter

public DependencyFilter getDependencyFilter(ResolutionScope resolutionScope)

Description copied from interface: InternalScopeManager

Resolver specific: dependency filter to be used to support this scope (with its dependency and resolution scopes).

Specified by:

getDependencyFilter in interface InternalScopeManager

createDependencyScope

public DependencyScope createDependencyScope(String id,
 boolean transitive,
 Collection<BuildScopeQuery> presence)

Description copied from interface: InternalScopeManager

Creates dependency scope instance.

Should be invoked only via ScopeManagerConfiguration.buildDependencyScopes(InternalScopeManager).

Specified by:

createDependencyScope in interface InternalScopeManager

createSystemDependencyScope

public SystemDependencyScope createSystemDependencyScope(String id,
 boolean transitive,
 Collection<BuildScopeQuery> presence,
 String systemPathProperty)

Description copied from interface: InternalScopeManager

Creates system dependency scope instance. This method may be invoked only once, as there can be only one instance of SystemDependencyScope!

Should be invoked only via ScopeManagerConfiguration.buildDependencyScopes(InternalScopeManager).

Specified by:

createSystemDependencyScope in interface InternalScopeManager

createResolutionScope

public ResolutionScope createResolutionScope(String id,
 InternalScopeManager.Mode mode,
 Collection<BuildScopeQuery> wantedPresence,
 Collection<DependencyScope> explicitlyIncluded,
 Collection<DependencyScope> transitivelyExcluded)

Description copied from interface: InternalScopeManager

Creates resolution scope instance.

Should be invoked only via ScopeManagerConfiguration.buildResolutionScopes(InternalScopeManager).

Specified by:

createResolutionScope in interface InternalScopeManager

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object