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.shared.release.versions;
20  
21  /**
22   * Represent the different version representations during the release-prepare phase
23   *
24   */
25  public interface VersionInfo extends Comparable<VersionInfo> {
26  
27      /**
28       * Returns a string representing the version with a snapshot specification
29       *
30       * @return the snapshot version transformation of the original value
31       */
32      String getSnapshotVersionString();
33  
34      /**
35       * Returns a string representing the version without a snapshot specification.
36       *
37       * @return the final version transformation of the original value
38       */
39      String getReleaseVersionString();
40  
41      /**
42       * Returns a {@link org.apache.maven.shared.release.versions.VersionInfo} object which represents the next version
43       *    of this object.
44       *
45       * @return the next VersionInfo
46       */
47      VersionInfo getNextVersion();
48  
49      /**
50       * Returns whether this represents a snapshot version.
51       *
52       * @return {@code true} if the original value was a snapshot, otherwise {@code false}
53       */
54      boolean isSnapshot();
55  }