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