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