1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.api.services;
20
21 import java.util.List;
22
23 import org.apache.maven.api.ArtifactCoordinates;
24 import org.apache.maven.api.RemoteRepository;
25 import org.apache.maven.api.Service;
26 import org.apache.maven.api.Session;
27 import org.apache.maven.api.annotations.Consumer;
28 import org.apache.maven.api.annotations.Experimental;
29 import org.apache.maven.api.annotations.Nonnull;
30 import org.apache.maven.api.annotations.Nullable;
31
32 /**
33 * Parses and evaluates version ranges encountered in dependency declarations.
34 *
35 * @since 4.0.0
36 */
37 @Experimental
38 @Consumer
39 public interface VersionRangeResolver extends Service {
40
41 /**
42 * Expands a version range to a list of matching versions, in ascending order.
43 * For example, resolves "[3.8,4.0)" to "3.8", "3.8.1", "3.8.2".
44 * The returned list of versions is only dependent on the configured repositories and their contents.
45 * The supplied request may also refer to a single concrete version rather than a version range.
46 * In this case though, the result contains simply the (parsed) input version, regardless of the
47 * repositories and their contents.
48 *
49 * @param session the session to use
50 * @param artifactCoordinates t
51 * @return the version range resolution result
52 * @throws VersionResolverException if an errors occurs
53 */
54 @Nonnull
55 default VersionRangeResolverResult resolve(
56 @Nonnull Session session, @Nonnull ArtifactCoordinates artifactCoordinates)
57 throws VersionResolverException {
58 return resolve(VersionRangeResolverRequest.build(session, artifactCoordinates));
59 }
60
61 /**
62 * Expands a version range to a list of matching versions, in ascending order.
63 * For example, resolves "[3.8,4.0)" to "3.8", "3.8.1", "3.8.2".
64 * The returned list of versions is only dependent on the configured repositories and their contents.
65 * The supplied request may also refer to a single concrete version rather than a version range.
66 * In this case though, the result contains simply the (parsed) input version, regardless of the
67 * repositories and their contents.
68 *
69 * @param session the session to use
70 * @param artifactCoordinates t
71 * @param repositories the repositories to use (if {@code null}, the session repositories are used)
72 * @return the version range resolution result
73 * @throws VersionResolverException if an errors occurs
74 */
75 @Nonnull
76 default VersionRangeResolverResult resolve(
77 @Nonnull Session session,
78 @Nonnull ArtifactCoordinates artifactCoordinates,
79 @Nullable List<RemoteRepository> repositories)
80 throws VersionResolverException {
81 return resolve(VersionRangeResolverRequest.build(session, artifactCoordinates, repositories));
82 }
83
84 @Nonnull
85 VersionRangeResolverResult resolve(@Nonnull VersionRangeResolverRequest request)
86 throws VersionRangeResolverException;
87 }