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