Class ContextualSnapshotVersionFilter
- java.lang.Object
-
- org.eclipse.aether.util.graph.version.ContextualSnapshotVersionFilter
-
- All Implemented Interfaces:
VersionFilter
public final class ContextualSnapshotVersionFilter extends Object implements VersionFilter
A version filter that blocks "*-SNAPSHOT" versions if theroot artifact
of the dependency graph is not a snapshot. Alternatively, this filter can be forced to always ban snapshot versions by setting the booleanconfiguration property
CONFIG_PROP_ENABLE
totrue
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.eclipse.aether.collection.VersionFilter
VersionFilter.VersionFilterContext
-
-
Field Summary
Fields Modifier and Type Field Description static String
CONFIG_PROP_ENABLE
The key in the repository session'sconfiguration properties
used to store aBoolean
flag whether this filter should be forced to ban snapshots.
-
Constructor Summary
Constructors Constructor Description ContextualSnapshotVersionFilter()
Creates a new instance of this version filter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VersionFilter
deriveChildFilter(DependencyCollectionContext context)
Derives a version filter for the specified collection context.boolean
equals(Object obj)
void
filterVersions(VersionFilter.VersionFilterContext context)
Filters the available versions for a given dependency.int
hashCode()
-
-
-
Field Detail
-
CONFIG_PROP_ENABLE
public static final String CONFIG_PROP_ENABLE
The key in the repository session'sconfiguration properties
used to store aBoolean
flag whether this filter should be forced to ban snapshots. By default, snapshots are only filtered if the root artifact is not a snapshot.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContextualSnapshotVersionFilter
public ContextualSnapshotVersionFilter()
Creates a new instance of this version filter.
-
-
Method Detail
-
filterVersions
public void filterVersions(VersionFilter.VersionFilterContext context)
Description copied from interface:VersionFilter
Filters the available versions for a given dependency. Implementations will usually callcontext.iterator()
to inspect the available versions and useIterator.remove()
to delete unacceptable versions. If no versions remain after all filtering has been performed, the dependency collection process will automatically fail, i.e. implementations need not handle this situation on their own.- Specified by:
filterVersions
in interfaceVersionFilter
- Parameters:
context
- The version filter context, must not benull
.
-
deriveChildFilter
public VersionFilter deriveChildFilter(DependencyCollectionContext context)
Description copied from interface:VersionFilter
Derives a version filter for the specified collection context. The derived filter will be used to handle version ranges encountered in child dependencies of the current node. When calculating the child filter, implementors are strongly advised to simply return the current instance if nothing changed to help save memory.- Specified by:
deriveChildFilter
in interfaceVersionFilter
- Parameters:
context
- The dependency collection context, must not benull
.- Returns:
- The version filter for the target node or
null
if versions should not be filtered any more.
-
-