1 package org.eclipse.aether.impl;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import org.eclipse.aether.RepositorySystem;
23 import org.eclipse.aether.RepositorySystemSession;
24 import org.eclipse.aether.resolution.VersionRangeRequest;
25 import org.eclipse.aether.resolution.VersionRangeResolutionException;
26 import org.eclipse.aether.resolution.VersionRangeResult;
27
28 /**
29 * Parses and evaluates version ranges encountered in dependency declarations.
30 *
31 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
32 */
33 public interface VersionRangeResolver
34 {
35
36 /**
37 * Expands a version range to a list of matching versions, in ascending order. For example, resolves "[3.8,4.0)" to
38 * "3.8", "3.8.1", "3.8.2". The returned list of versions is only dependent on the configured repositories and their
39 * contents, the list is not processed by the {@link RepositorySystemSession#getVersionFilter() session's version
40 * filter}.
41 * <p>
42 * The supplied request may also refer to a single concrete version rather than a version range. In this case
43 * though, the result contains simply the (parsed) input version, regardless of the repositories and their contents.
44 *
45 * @param session The repository session, must not be {@code null}.
46 * @param request The version range request, must not be {@code null}.
47 * @return The version range result, never {@code null}.
48 * @throws VersionRangeResolutionException If the requested range could not be parsed. Note that an empty range does
49 * not raise an exception.
50 * @see RepositorySystem#resolveVersionRange(RepositorySystemSession, VersionRangeRequest)
51 */
52 VersionRangeResult resolveVersionRange( RepositorySystemSession session, VersionRangeRequest request )
53 throws VersionRangeResolutionException;
54
55 }