Package org.eclipse.aether.util.graph.transformer

Class ConfigurableVersionSelector

java.lang.Object

org.eclipse.aether.util.graph.transformer.ConflictResolver.VersionSelector

org.eclipse.aether.util.graph.transformer.ConfigurableVersionSelector

public class ConfigurableVersionSelector
extends ConflictResolver.VersionSelector

A configurable version selector for use with ConflictResolver that resolves version conflicts using a specified strategy. If there is no single node that satisfies all encountered version ranges, the selector will fail. Based on configuration, this selector may fail for other reasons as well.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ConfigurableVersionSelector.ConflictGroup
static class	ConfigurableVersionSelector.Highest	Selection strategy that selects "highest" version.
static class	ConfigurableVersionSelector.MajorVersionConvergence	Example selection strategy (used in tests and demos), is not recommended to be used in production.
static class	ConfigurableVersionSelector.Nearest	Selection strategy that selects "nearest" (to the root) version.
static interface	ConfigurableVersionSelector.SelectionStrategy	The strategy how "winner" is being selected.
static class	ConfigurableVersionSelector.VersionConvergence	Example selection strategy (used in tests and demos), is not recommended to be used in production.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIG_PROP_SELECTION_STRATEGY	The name of the version selection strategy to use in conflict resolution: "nearest" (default) or "highest".
static java.lang.String	DEFAULT_SELECTION_STRATEGY
static java.lang.String	HIGHEST_SELECTION_STRATEGY
static java.lang.String	NEAREST_SELECTION_STRATEGY
protected ConfigurableVersionSelector.SelectionStrategy	selectionStrategy	The strategy of winner selection, never null.

Constructor Summary

Constructors

Constructor	Description
ConfigurableVersionSelector()	Creates a new instance of this version selector that will use configured selection strategy dynamically.
ConfigurableVersionSelector(ConfigurableVersionSelector.SelectionStrategy selectionStrategy)	Creates a new instance of this version selector using passed in selection strategy always.

Method Summary

Modifier and Type	Method	Description
protected void	backtrack(ConfigurableVersionSelector.ConflictGroup group, ConflictResolver.ConflictContext context)
ConflictResolver.VersionSelector	getInstance(org.eclipse.aether.graph.DependencyNode root, org.eclipse.aether.collection.DependencyGraphTransformationContext context)	Retrieves the version selector for use during the specified graph transformation.
protected boolean	isAcceptableByConstraints(ConfigurableVersionSelector.ConflictGroup group, org.eclipse.aether.version.Version version)
static org.eclipse.aether.collection.UnsolvableVersionConflictException	newFailure(java.lang.String message, ConflictResolver.ConflictContext context)	Helper method to create failure, creates instance of UnsolvableVersionConflictException.
void	selectVersion(ConflictResolver.ConflictContext context)	Determines the winning node among conflicting dependencies.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PROP_SELECTION_STRATEGY

public static final java.lang.String CONFIG_PROP_SELECTION_STRATEGY

The name of the version selection strategy to use in conflict resolution: "nearest" (default) or "highest".

Since:

2.0.11

See Also:

Constant Field Values

NEAREST_SELECTION_STRATEGY

public static final java.lang.String NEAREST_SELECTION_STRATEGY

See Also:

Constant Field Values

HIGHEST_SELECTION_STRATEGY

public static final java.lang.String HIGHEST_SELECTION_STRATEGY

See Also:

Constant Field Values

DEFAULT_SELECTION_STRATEGY

public static final java.lang.String DEFAULT_SELECTION_STRATEGY

See Also:

Constant Field Values

selectionStrategy

protected final ConfigurableVersionSelector.SelectionStrategy selectionStrategy

The strategy of winner selection, never null.

Constructor Detail

ConfigurableVersionSelector

public ConfigurableVersionSelector()

Creates a new instance of this version selector that will use configured selection strategy dynamically.

ConfigurableVersionSelector

public ConfigurableVersionSelector(ConfigurableVersionSelector.SelectionStrategy selectionStrategy)

Creates a new instance of this version selector using passed in selection strategy always.

Parameters:

selectionStrategy - the winner selection strategy, must not be null. Maven3 used ConfigurableVersionSelector.Nearest strategy.

Method Detail

getInstance

public ConflictResolver.VersionSelector getInstance(org.eclipse.aether.graph.DependencyNode root,
                                                    org.eclipse.aether.collection.DependencyGraphTransformationContext context)
                                             throws org.eclipse.aether.RepositoryException

Description copied from class: ConflictResolver.VersionSelector

Retrieves the version selector for use during the specified graph transformation. The conflict resolver calls this method once per ConflictResolver.transformGraph(DependencyNode, DependencyGraphTransformationContext) invocation to allow implementations to prepare any auxiliary data that is needed for their operation. Given that implementations must be stateless, a new instance needs to be returned to hold such auxiliary data. The default implementation simply returns the current instance which is appropriate for implementations which do not require auxiliary data.

Overrides:

getInstance in class ConflictResolver.VersionSelector

Parameters:

root - the root node of the (possibly cyclic!) graph to transform, must not be null

context - the graph transformation context, must not be null

Returns:

the scope deriver to use for the given graph transformation, never null

Throws:

org.eclipse.aether.RepositoryException - if the instance could not be retrieved

selectVersion

public void selectVersion(ConflictResolver.ConflictContext context)
                   throws org.eclipse.aether.RepositoryException

Description copied from class: ConflictResolver.VersionSelector

Determines the winning node among conflicting dependencies. Implementations will usually iterate ConflictResolver.ConflictContext.getItems(), inspect ConflictResolver.ConflictItem.getNode() and eventually call ConflictResolver.ConflictContext.setWinner(ConflictResolver.ConflictItem) to deliver the winner. Failure to select a winner will automatically fail the entire conflict resolution.

Specified by:

selectVersion in class ConflictResolver.VersionSelector

Parameters:

context - the conflict context, must not be null

Throws:

org.eclipse.aether.RepositoryException - if the version selection failed

backtrack

protected void backtrack(ConfigurableVersionSelector.ConflictGroup group,
                         ConflictResolver.ConflictContext context)
                  throws org.eclipse.aether.collection.UnsolvableVersionConflictException

Throws:

org.eclipse.aether.collection.UnsolvableVersionConflictException

isAcceptableByConstraints

protected boolean isAcceptableByConstraints(ConfigurableVersionSelector.ConflictGroup group,
                                            org.eclipse.aether.version.Version version)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newFailure

public static org.eclipse.aether.collection.UnsolvableVersionConflictException newFailure(java.lang.String message,
                                                                                          ConflictResolver.ConflictContext context)

Helper method to create failure, creates instance of UnsolvableVersionConflictException.