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.VersionRange;
24 import org.apache.maven.api.annotations.Experimental;
25 import org.apache.maven.api.annotations.Nonnull;
26
27 /**
28 * Service interface to parse {@link Version} and {@link VersionRange}.
29 *
30 * @since 4.0
31 */
32 @Experimental
33 public interface VersionParser extends Service {
34 /**
35 * Parses the specified version string, for example "1.0".
36 *
37 * @param version the version string to parse, must not be {@code null}
38 * @return the parsed version, never {@code null}
39 * @throws VersionParserException if the string violates the syntax rules of this scheme
40 * @see org.apache.maven.api.Session#parseVersion(String)
41 */
42 @Nonnull
43 Version parseVersion(@Nonnull String version);
44
45 /**
46 * Parses the specified version range specification, for example "[1.0,2.0)".
47 *
48 * @param range the range specification to parse, must not be {@code null}
49 * @return the parsed version range, never {@code null}
50 * @throws VersionParserException if the range specification violates the syntax rules of this scheme
51 */
52 @Nonnull
53 VersionRange parseVersionRange(@Nonnull String range);
54
55 /**
56 * Checks whether a given artifact version is considered a {@code SNAPSHOT} or not.
57 */
58 boolean isSnapshot(@Nonnull String version);
59 }