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.ArtifactCoordinate;
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 * Resolves artifact meta/pseudo versions.
30 */
31 @Experimental
32 @Consumer
33 public interface VersionResolver extends Service {
34
35 /**
36 * Resolves an artifact's meta version (if any) to a concrete version. For example, resolves "1.0-SNAPSHOT"
37 * to "1.0-20090208.132618-23" or "RELEASE"/"LATEST" to "2.0".
38 *
39 * @param session The repository session, must not be {@code null}.
40 * @param artifactCoordinate The artifact coordinate for which the version needs to be resolved, must not be {@code null}
41 * @return The version result, never {@code null}.
42 * @throws VersionResolverException If the metaversion could not be resolved.
43 */
44 @Nonnull
45 default VersionResolverResult resolve(@Nonnull Session session, @Nonnull ArtifactCoordinate artifactCoordinate)
46 throws VersionResolverException {
47 return resolve(VersionResolverRequest.build(session, artifactCoordinate));
48 }
49
50 /**
51 * Resolves an artifact's meta version (if any) to a concrete version. For example, resolves "1.0-SNAPSHOT"
52 * to "1.0-20090208.132618-23" or "RELEASE"/"LATEST" to "2.0".
53 *
54 * @param request The version request, must not be {@code null}.
55 * @return The version result, never {@code null}.
56 * @throws VersionResolverException If the metaversion could not be resolved.
57 */
58 @Nonnull
59 VersionResolverResult resolve(@Nonnull VersionResolverRequest request) throws VersionResolverException;
60 }