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