Package org.apache.maven.api.services

Interface VersionRangeResolverRequest

All Superinterfaces:

RepositoryAwareRequest, Request<Session>

@Experimental
public interface VersionRangeResolverRequest
extends RepositoryAwareRequest

A request to resolve a version range to a list of matching versions. This request is used by VersionRangeResolver to expand version ranges (e.g., "[3.8,4.0)") into concrete versions available in the configured repositories.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	VersionRangeResolverRequest.Nature	Specifies which type of repositories to query when resolving version ranges.
static class	VersionRangeResolverRequest.VersionResolverRequestBuilder	Builder for VersionRangeResolverRequest.

Method Summary

Modifier and Type	Method	Description
static VersionRangeResolverRequest	build(Session session, ArtifactCoordinates artifactCoordinates)	Creates a version range resolver request using the session's repositories.
static VersionRangeResolverRequest	build(Session session, ArtifactCoordinates artifactCoordinates, List<RemoteRepository> repositories)	Creates a version range resolver request.
static VersionRangeResolverRequest	build(Session session, ArtifactCoordinates artifactCoordinates, List<RemoteRepository> repositories, VersionRangeResolverRequest.Nature nature)	Creates a version range resolver request.
static VersionRangeResolverRequest.VersionResolverRequestBuilder	builder()	Creates a new builder for version range resolver requests.
ArtifactCoordinates	getArtifactCoordinates()	Gets the artifact coordinates whose version range should be resolved.
VersionRangeResolverRequest.Nature	getNature()	Gets the nature of repositories to query when resolving the version range.

Methods inherited from interface org.apache.maven.api.services.RepositoryAwareRequest

getRepositories, validate

Methods inherited from interface org.apache.maven.api.services.Request

equals, getSession, getTrace, hashCode, toString

Method Details

getArtifactCoordinates

@Nonnull
ArtifactCoordinates getArtifactCoordinates()

Gets the artifact coordinates whose version range should be resolved. The coordinates may contain a version range (e.g., "[1.0,2.0)") or a single version.

Returns:

the artifact coordinates, never null

getNature

@Nonnull
VersionRangeResolverRequest.Nature getNature()

Gets the nature of repositories to query when resolving the version range. This determines whether to search in release repositories, snapshot repositories, or both.

Returns:

the repository nature, never null

build

@Nonnull
static VersionRangeResolverRequest build(@Nonnull
 Session session,
 @Nonnull
 ArtifactCoordinates artifactCoordinates)

Creates a version range resolver request using the session's repositories.

Parameters:

session - the session to use, must not be null

artifactCoordinates - the artifact coordinates whose version range should be resolved, must not be null

Returns:

the version range resolver request, never null

build

@Nonnull
static VersionRangeResolverRequest build(@Nonnull
 Session session,
 @Nonnull
 ArtifactCoordinates artifactCoordinates,
 @Nullable
 List<RemoteRepository> repositories)

Creates a version range resolver request.

Parameters:

session - the session to use, must not be null

artifactCoordinates - the artifact coordinates whose version range should be resolved, must not be null

repositories - the repositories to use, or null to use the session's repositories

Returns:

the version range resolver request, never null

build

@Nonnull
static VersionRangeResolverRequest build(@Nonnull
 Session session,
 @Nonnull
 ArtifactCoordinates artifactCoordinates,
 @Nullable
 List<RemoteRepository> repositories,
 @Nullable
 VersionRangeResolverRequest.Nature nature)

Creates a version range resolver request.

Parameters:

session - the session to use, must not be null

artifactCoordinates - the artifact coordinates whose version range should be resolved, must not be null

repositories - the repositories to use, or null to use the session's repositories

nature - the nature of repositories to query when resolving the version range, or null to use the default

Returns:

the version range resolver request, never null

builder

@Nonnull
static VersionRangeResolverRequest.VersionResolverRequestBuilder builder()

Creates a new builder for version range resolver requests.

Returns:

a new builder, never null