1 package org.apache.maven.api.services;
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 import org.apache.maven.api.Service;
23 import org.apache.maven.api.Version;
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
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 * Checks whether a given artifact version is considered a {@code SNAPSHOT} or not.
59 */
60 boolean isSnapshot( @Nonnull String version );
61
62 }