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.version;
20
21 /**
22 * A version scheme that handles interpretation of version strings to facilitate their comparison.
23 */
24 public interface VersionScheme {
25
26 /**
27 * Parses the specified version string, for example "1.0".
28 *
29 * @param version The version string to parse, must not be {@code null}.
30 * @return The parsed version, never {@code null}.
31 * @throws InvalidVersionSpecificationException If the string violates the syntax rules of this scheme.
32 */
33 Version parseVersion(String version) throws InvalidVersionSpecificationException;
34
35 /**
36 * Parses the specified version range specification, for example "[1.0,2.0)".
37 *
38 * @param range The range specification to parse, must not be {@code null}.
39 * @return The parsed version range, never {@code null}.
40 * @throws InvalidVersionSpecificationException If the range specification violates the syntax rules of this scheme.
41 */
42 VersionRange parseVersionRange(String range) throws InvalidVersionSpecificationException;
43
44 /**
45 * Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0),(2.0,)".
46 *
47 * @param constraint The constraint specification to parse, must not be {@code null}.
48 * @return The parsed version constraint, never {@code null}.
49 * @throws InvalidVersionSpecificationException If the constraint specification violates the syntax rules of this
50 * scheme.
51 */
52 VersionConstraint parseVersionConstraint(String constraint) throws InvalidVersionSpecificationException;
53 }