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

Class ConflictResolver.OptionalitySelector

java.lang.Object

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

Direct Known Subclasses:

SimpleOptionalitySelector

Enclosing class:

ConflictResolver

public abstract static class ConflictResolver.OptionalitySelector
extends Object

An extension point of ConflictResolver that determines the effective optional flag of a dependency from a potentially conflicting set of derived optionalities. The optionality selector gets invoked after the ConflictResolver.VersionSelector has picked the winning node.

Note: Implementations must be stateless.

Constructor Summary

Constructors

Constructor	Description
OptionalitySelector()

Method Summary

Modifier and Type	Method	Description
ConflictResolver.OptionalitySelector	getInstance(org.eclipse.aether.graph.DependencyNode root, org.eclipse.aether.collection.DependencyGraphTransformationContext context)	Retrieves the optionality selector for use during the specified graph transformation.
abstract void	selectOptionality(ConflictResolver.ConflictContext context)	Determines the effective optional flag of the dependency given by ConflictResolver.ConflictContext.getWinner().

Methods inherited from class java.lang.Object

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

Constructor Details

OptionalitySelector

public OptionalitySelector()

Method Details

getInstance

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

Retrieves the optionality 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.

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 optionality selector to use for the given graph transformation, never null.

Throws:

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

selectOptionality

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

Determines the effective optional flag of the dependency given by ConflictResolver.ConflictContext.getWinner(). Implementations will usually iterate ConflictResolver.ConflictContext.getItems(), inspect ConflictResolver.ConflictItem.getOptionalities() and eventually call ConflictResolver.ConflictContext.setOptional(Boolean) to deliver the effective optional flag.

Parameters:

context - The conflict context, must not be null.

Throws:

org.eclipse.aether.RepositoryException - If the optionality selection failed.