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.api.services;
20
21 import org.apache.maven.api.Service;
22 import org.apache.maven.api.Version;
23 import org.apache.maven.api.VersionConstraint;
24 import org.apache.maven.api.VersionRange;
25 import org.apache.maven.api.annotations.Experimental;
26 import org.apache.maven.api.annotations.Nonnull;
27
28 /**
29 * Service interface to parse {@link Version} and {@link VersionRange}.
30 *
31 * @since 4.0.0
32 */
33 @Experimental
34 public interface VersionParser extends Service {
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 * @see org.apache.maven.api.Session#parseVersion(String)
43 */
44 @Nonnull
45 Version parseVersion(@Nonnull String version);
46
47 /**
48 * Parses the specified version range specification, for example "[1.0,2.0)".
49 *
50 * @param range the range specification to parse, must not be {@code null}
51 * @return the parsed version range, never {@code null}
52 * @throws VersionParserException if the range specification violates the syntax rules of this scheme
53 */
54 @Nonnull
55 VersionRange parseVersionRange(@Nonnull String range);
56
57 /**
58 * Parses the specified version constraint specification, for example "1.0" or "[1.0,2.0)".
59 *
60 * @param constraint the constraint specification to parse, must not be {@code null}
61 * @return the parsed version constraint, never {@code null}
62 * @throws VersionParserException if the range specification violates the syntax rules of this scheme
63 */
64 @Nonnull
65 VersionConstraint parseVersionConstraint(@Nonnull String constraint);
66
67 /**
68 * Checks whether a given artifact version is considered a {@code SNAPSHOT} or not.
69 */
70 boolean isSnapshot(@Nonnull String version);
71 }