001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.impl;
020
021import org.eclipse.aether.RepositorySystem;
022import org.eclipse.aether.RepositorySystemSession;
023import org.eclipse.aether.resolution.VersionRangeRequest;
024import org.eclipse.aether.resolution.VersionRangeResolutionException;
025import org.eclipse.aether.resolution.VersionRangeResult;
026
027/**
028 * Parses and evaluates version ranges encountered in dependency declarations.
029 *
030 * @provisional This type is provisional and can be changed, moved or removed without prior notice.
031 */
032public interface VersionRangeResolver {
033
034    /**
035     * Expands a version range to a list of matching versions, in ascending order. For example, resolves "[3.8,4.0)" to
036     * "3.8", "3.8.1", "3.8.2". The returned list of versions is only dependent on the configured repositories and their
037     * contents, the list is not processed by the {@link RepositorySystemSession#getVersionFilter() session's version
038     * filter}.
039     * <p>
040     * The supplied request may also refer to a single concrete version rather than a version range. In this case
041     * though, the result contains simply the (parsed) input version, regardless of the repositories and their contents.
042     *
043     * @param session The repository session, must not be {@code null}.
044     * @param request The version range request, must not be {@code null}.
045     * @return The version range result, never {@code null}.
046     * @throws VersionRangeResolutionException If the requested range could not be parsed. Note that an empty range does
047     *             not raise an exception.
048     * @see RepositorySystem#resolveVersionRange(RepositorySystemSession, VersionRangeRequest)
049     */
050    VersionRangeResult resolveVersionRange(RepositorySystemSession session, VersionRangeRequest request)
051            throws VersionRangeResolutionException;
052}