001package org.eclipse.aether.version;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 * 
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 * 
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * A version scheme that handles interpretation of version strings to facilitate their comparison.
024 */
025public interface VersionScheme
026{
027
028    /**
029     * Parses the specified version string, for example "1.0".
030     * 
031     * @param version The version string to parse, must not be {@code null}.
032     * @return The parsed version, never {@code null}.
033     * @throws InvalidVersionSpecificationException If the string violates the syntax rules of this scheme.
034     */
035    Version parseVersion( String version )
036        throws InvalidVersionSpecificationException;
037
038    /**
039     * Parses the specified version range specification, for example "[1.0,2.0)".
040     * 
041     * @param range The range specification to parse, must not be {@code null}.
042     * @return The parsed version range, never {@code null}.
043     * @throws InvalidVersionSpecificationException If the range specification violates the syntax rules of this scheme.
044     */
045    VersionRange parseVersionRange( String range )
046        throws InvalidVersionSpecificationException;
047
048    /**
049     * Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0),(2.0,)".
050     * 
051     * @param constraint The constraint specification to parse, must not be {@code null}.
052     * @return The parsed version constraint, never {@code null}.
053     * @throws InvalidVersionSpecificationException If the constraint specification violates the syntax rules of this
054     *             scheme.
055     */
056    VersionConstraint parseVersionConstraint( final String constraint )
057        throws InvalidVersionSpecificationException;
058
059}