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.eclipse.aether.impl;
20
21 import org.eclipse.aether.RepositorySystem;
22 import org.eclipse.aether.RepositorySystemSession;
23 import org.eclipse.aether.resolution.VersionRangeRequest;
24 import org.eclipse.aether.resolution.VersionRangeResolutionException;
25 import org.eclipse.aether.resolution.VersionRangeResult;
26
27 /**
28 * Parses and evaluates version ranges encountered in dependency declarations.
29 *
30 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
31 */
32 public interface VersionRangeResolver {
33
34 /**
35 * Expands a version range to a list of matching versions, in ascending order. For example, resolves "[3.8,4.0)" to
36 * "3.8", "3.8.1", "3.8.2". The returned list of versions is only dependent on the configured repositories and their
37 * contents, the list is not processed by the {@link RepositorySystemSession#getVersionFilter() session's version
38 * filter}.
39 * <p>
40 * The supplied request may also refer to a single concrete version rather than a version range. In this case
41 * though, the result contains simply the (parsed) input version, regardless of the repositories and their contents.
42 *
43 * @param session The repository session, must not be {@code null}.
44 * @param request The version range request, must not be {@code null}.
45 * @return The version range result, never {@code null}.
46 * @throws VersionRangeResolutionException If the requested range could not be parsed. Note that an empty range does
47 * not raise an exception.
48 * @see RepositorySystem#resolveVersionRange(RepositorySystemSession, VersionRangeRequest)
49 */
50 VersionRangeResult resolveVersionRange(RepositorySystemSession session, VersionRangeRequest request)
51 throws VersionRangeResolutionException;
52 }