View Javadoc
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 or meta-version of an artifact or a dependency.
26   * A meta-version is a version suffixed with the {@code SNAPSHOT} keyword.
27   * Versions are usually parsed using the {@link org.apache.maven.api.services.VersionParser} service.
28   *
29   * @since 4.0.0
30   * @see org.apache.maven.api.services.VersionParser#parseVersion(String)
31   * @see org.apache.maven.api.Session#parseVersion(String)
32   * @see VersionConstraint
33   * @see VersionRange
34   */
35  @Experimental
36  public interface Version extends Comparable<Version> {
37      /**
38       * Returns a string representation of this version.
39       * @return the string representation of this version
40       */
41      @Nonnull
42      String asString();
43  }