1 package org.apache.maven.api;
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.annotations.Experimental;
23 import org.apache.maven.api.annotations.Nonnull;
24
25 /**
26 * A version usually parsed using the {@link org.apache.maven.api.services.VersionParser} service.
27 *
28 * @since 4.0
29 * @see org.apache.maven.api.services.VersionParser#parseVersion(String)
30 * @see org.apache.maven.api.Session#parseVersion(String)
31 */
32 @Experimental
33 public interface Version
34 extends Comparable<Version>
35 {
36
37 // TODO: add access to the version information
38
39 /**
40 * Returns a string representation of this version.
41 * @return the string representation of this version
42 */
43 @Nonnull
44 String asString();
45
46 }