View Javadoc
1   package org.apache.maven.shared.release.versions;
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  /**
23   * @todo this has an overlap with ArtifactVersion in maven-artifact - would be good to migrate this there.
24   */
25  public interface VersionInfo
26      extends Comparable<VersionInfo>
27  {
28  
29      /**
30       * Returns a string representing the version with a snapshot specification
31       *
32       * @return the snapshot version transformation of the original value
33       */
34      String getSnapshotVersionString();
35  
36      /**
37       * Returns a string representing the version without a snapshot specification.
38       *
39       * @return the final version transformation of the original value
40       */
41      String getReleaseVersionString();
42  
43      /**
44       * Returns a {@link VersionInfo} object which represents the next version of this object.
45       *
46       * @return the next VersionInfo
47       */
48      VersionInfo getNextVersion();
49  
50      /**
51       * Returns whether this represents a snapshot version.
52       *
53       * @return {@code true} if the original value was a snapshot, otherwise {@code false}
54       */
55      boolean isSnapshot();
56  }