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

Class ScopeDependencySelector

java.lang.Object

org.eclipse.aether.internal.impl.scope.ScopeDependencySelector

All Implemented Interfaces:

DependencySelector

public final class ScopeDependencySelector
extends Object
implements DependencySelector

A dependency selector that filters transitive dependencies based on their scope. It is configurable from which level applies, as it depend on "as project" and "as dependency" use cases.

Important note: equals/hashCode must factor in starting state, as instances of this class (potentially differentially configured) are used now in session, but are kept in a set.

Note: This filter does not assume any relationships between the scopes. In particular, the filter is not aware of scopes that logically include other scopes.

See Also:

• Dependency.getScope()

Method Summary

Modifier and Type	Method	Description
DependencySelector	deriveChildSelector(DependencyCollectionContext context)	Derives a dependency selector for the specified collection context.
boolean	equals(Object obj)
static ScopeDependencySelector	from(int applyFrom, Collection<String> included, Collection<String> excluded)	Selects dependencies by scope starting from given depth (1=root, 2=direct, 3=transitives of direct ones...).
static ScopeDependencySelector	fromDirect(Collection<String> included, Collection<String> excluded)	Selects dependencies by scope starting from direct dependencies.
static ScopeDependencySelector	fromRoot(Collection<String> included, Collection<String> excluded)	Selects dependencies by scope always (from root).
static ScopeDependencySelector	fromTo(int applyFrom, int applyTo, Collection<String> included, Collection<String> excluded)	Selects dependencies by scope starting from given depth (1=root, 2=direct, 3=transitives of direct ones...) to given depth.
int	hashCode()
static ScopeDependencySelector	legacy(Collection<String> included, Collection<String> excluded)	This enables "legacy" mode (proper): in Resolver 1.x "transitive" state depended on the presence or absence of the root node.
boolean	selectDependency(Dependency dependency)	Decides whether the specified dependency should be included in the dependency graph.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

legacy

public static ScopeDependencySelector legacy(Collection<String> included,
 Collection<String> excluded)

This enables "legacy" mode (proper): in Resolver 1.x "transitive" state depended on the presence or absence of the root node.

fromRoot

public static ScopeDependencySelector fromRoot(Collection<String> included,
 Collection<String> excluded)

Selects dependencies by scope always (from root).

fromDirect

public static ScopeDependencySelector fromDirect(Collection<String> included,
 Collection<String> excluded)

Selects dependencies by scope starting from direct dependencies.

from

public static ScopeDependencySelector from(int applyFrom,
 Collection<String> included,
 Collection<String> excluded)

Selects dependencies by scope starting from given depth (1=root, 2=direct, 3=transitives of direct ones...).

fromTo

public static ScopeDependencySelector fromTo(int applyFrom,
 int applyTo,
 Collection<String> included,
 Collection<String> excluded)

Selects dependencies by scope starting from given depth (1=root, 2=direct, 3=transitives of direct ones...) to given depth.

selectDependency

public boolean selectDependency(Dependency dependency)

Description copied from interface: DependencySelector

Decides whether the specified dependency should be included in the dependency graph.

Specified by:

selectDependency in interface DependencySelector

Parameters:

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

Returns:

false if the dependency should be excluded from the children of the current node, true otherwise.

deriveChildSelector

public DependencySelector deriveChildSelector(DependencyCollectionContext context)

Description copied from interface: DependencySelector

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

Specified by:

deriveChildSelector in interface DependencySelector

Parameters:

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

Returns:

The dependency selector for the target node or null if dependencies should be unconditionally included in the sub graph.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object