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.version;
020
021/**
022 * A version scheme that handles interpretation of version strings to facilitate their comparison.
023 */
024public interface VersionScheme {
025
026    /**
027     * Parses the specified version string, for example "1.0".
028     *
029     * @param version The version string to parse, must not be {@code null}.
030     * @return The parsed version, never {@code null}.
031     * @throws InvalidVersionSpecificationException If the string violates the syntax rules of this scheme.
032     */
033    Version parseVersion(String version) throws InvalidVersionSpecificationException;
034
035    /**
036     * Parses the specified version range specification, for example "[1.0,2.0)".
037     *
038     * @param range The range specification to parse, must not be {@code null}.
039     * @return The parsed version range, never {@code null}.
040     * @throws InvalidVersionSpecificationException If the range specification violates the syntax rules of this scheme.
041     */
042    VersionRange parseVersionRange(String range) throws InvalidVersionSpecificationException;
043
044    /**
045     * Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0),(2.0,)".
046     *
047     * @param constraint The constraint specification to parse, must not be {@code null}.
048     * @return The parsed version constraint, never {@code null}.
049     * @throws InvalidVersionSpecificationException If the constraint specification violates the syntax rules of this
050     *             scheme.
051     */
052    VersionConstraint parseVersionConstraint(String constraint) throws InvalidVersionSpecificationException;
053}