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 org.apache.maven.api.ArtifactCoordinates;
22 import org.apache.maven.api.Service;
23 import org.apache.maven.api.Session;
24 import org.apache.maven.api.annotations.Consumer;
25 import org.apache.maven.api.annotations.Experimental;
26 import org.apache.maven.api.annotations.Nonnull;
27
28 /**
29 * Parses and evaluates version ranges encountered in dependency declarations.
30 *
31 * @since 4.0.0
32 */
33 @Experimental
34 @Consumer
35 public interface VersionRangeResolver extends Service {
36
37 /**
38 * Expands a version range to a list of matching versions, in ascending order.
39 * For example, resolves "[3.8,4.0)" to "3.8", "3.8.1", "3.8.2".
40 * The returned list of versions is only dependent on the configured repositories and their contents.
41 * The supplied request may also refer to a single concrete version rather than a version range.
42 * In this case though, the result contains simply the (parsed) input version, regardless of the
43 * repositories and their contents.
44 *
45 * @param session the session to use
46 * @param artifactCoordinates t
47 * @return the version range resolution result
48 * @throws VersionResolverException if an errors occurs
49 */
50 @Nonnull
51 default VersionRangeResolverResult resolve(
52 @Nonnull Session session, @Nonnull ArtifactCoordinates artifactCoordinates)
53 throws VersionResolverException {
54 return resolve(VersionRangeResolverRequest.build(session, artifactCoordinates));
55 }
56
57 @Nonnull
58 VersionRangeResolverResult resolve(@Nonnull VersionRangeResolverRequest request)
59 throws VersionRangeResolverException;
60 }