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.VersionRange;
23 import org.apache.maven.api.annotations.Nonnull;
24 import org.apache.maven.api.services.VersionParserException;
25
26 /**
27 * Model builder specific version parser. It is intentionally not
28 * {@link org.apache.maven.api.services.VersionParser} as this is not a service,
29 * but at Maven runtime it MAY actually use that service.
30 *
31 * @since 4.0.0
32 */
33 public interface VersionParser {
34
35 /**
36 * Parses the specified version string, for example "1.0".
37 *
38 * @param version the version string to parse, must not be {@code null}
39 * @return the parsed version, never {@code null}
40 * @throws VersionParserException if the string violates the syntax rules of this scheme
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 }