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.apache.maven.model.version;
20
21 import org.apache.maven.api.Version;
22 import org.apache.maven.api.VersionConstraint;
23 import org.apache.maven.api.VersionRange;
24 import org.apache.maven.api.annotations.Nonnull;
25 import org.apache.maven.api.services.VersionParserException;
26
27 /**
28 * Model builder specific version parser. It is intentionally not
29 * {@link org.apache.maven.api.services.VersionParser} as this is not a service,
30 * but at Maven runtime it MAY actually use that service.
31 *
32 * @since 4.0.0
33 */
34 public interface ModelVersionParser {
35
36 /**
37 * Parses the specified version string, for example "1.0".
38 *
39 * @param version the version string to parse, must not be {@code null}
40 * @return the parsed version, never {@code null}
41 * @throws VersionParserException if the string violates the syntax rules of this scheme
42 */
43 @Nonnull
44 Version parseVersion(@Nonnull String version);
45
46 /**
47 * Parses the specified version range specification, for example "[1.0,2.0)".
48 *
49 * @param range the range specification to parse, must not be {@code null}
50 * @return the parsed version range, never {@code null}
51 * @throws VersionParserException if the range specification violates the syntax rules of this scheme
52 */
53 @Nonnull
54 VersionRange parseVersionRange(@Nonnull String range);
55
56 /**
57 * Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".
58 *
59 * @param constraint the range specification to parse, must not be {@code null}
60 * @return the parsed version constraint, never {@code null}
61 * @throws VersionParserException if the range specification violates the syntax rules of this scheme
62 */
63 @Nonnull
64 VersionConstraint parseVersionConstraint(@Nonnull String constraint);
65
66 /**
67 * Checks whether a given artifact version is considered a {@code SNAPSHOT} or not.
68 */
69 boolean isSnapshot(@Nonnull String version);
70 }