-
Notifications
You must be signed in to change notification settings - Fork 160
/
SemanticVersion.java
289 lines (256 loc) · 9.44 KB
/
SemanticVersion.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
/*******************************************************************************
* Copyright (c) 2020 Eurotech and/or its affiliates and others
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eurotech - initial API and implementation
*******************************************************************************/
package org.eclipse.kapua.commons.util;
/**
* Utility class to handle comparison between component versions.
*
* @see <a href="https://semver.org/">Semantic Versioning</a>.
* @since 1.2.0
*/
public class SemanticVersion {
private final String versionString;
private final VersionToken majorVersion;
private final VersionToken minorVersion;
private final VersionToken patchVersion;
/**
* Constructor.
* Parses the given {@link String} according to the rules defined by the <a href="https://semver.org/">Semantic Versioning</a>.
*
* @param version The {@link String} version to parse
* @since 1.2.0
*/
public SemanticVersion(String version) {
this.versionString = version;
String[] versionSplitted = version.split("\\.");
majorVersion = new VersionToken(versionSplitted[0]);
if (versionSplitted.length > 1) {
minorVersion = new VersionToken(versionSplitted[1]);
} else {
minorVersion = null;
}
if (versionSplitted.length > 2) {
patchVersion = new VersionToken(versionSplitted[2]);
} else {
patchVersion = null;
}
}
/**
* Gets the original {@link String} provided.
*
* @return The original {@link String} provided.
* @since 1.2.0
*/
public String getVersionString() {
return versionString;
}
/**
* Gets the major version.
*
* @return The major version.
* @since 1.2.0
*/
public VersionToken getMajorVersion() {
return majorVersion;
}
/**
* Gets the minor version.
*
* @return The minor version.
* @since 1.2.0
*/
public VersionToken getMinorVersion() {
return minorVersion;
}
/**
* Gets the patch version.
*
* @return The patch version.
* @since 1.2.0
*/
public VersionToken getPatchVersion() {
return patchVersion;
}
/**
* Compares {@code this} {@link SemanticVersion} with another {@link SemanticVersion}.
*
* @param other The {@link SemanticVersion} to use to compare.
* @return {@code true} if {@code this} {@link SemanticVersion} is after or matches the given {@link SemanticVersion}
* @since 1.2.0
*/
public boolean afterOrMatches(SemanticVersion other) {
return after(other) || matches(other);
}
/**
* Compares {@code this} {@link SemanticVersion} with another {@link SemanticVersion}.
*
* @param other The {@link SemanticVersion} to use to compare.
* @return {@code true} if {@code this} {@link SemanticVersion} is after the given {@link SemanticVersion}
* @since 1.2.0
*/
public boolean after(SemanticVersion other) {
if (getMajorVersion().after(other.getMajorVersion())) {
return true;
} else if (getMajorVersion().matches(other.getMajorVersion())) {
if (getMinorVersion() != null && getMinorVersion().after(other.getMinorVersion())) {
return true;
} else if (getMinorVersion().matches(other.getMinorVersion())) {
if (getPatchVersion() != null && getPatchVersion().after(other.getPatchVersion())) {
return true;
}
}
}
return false;
}
/**
* Compares {@code this} {@link SemanticVersion} with another {@link SemanticVersion}.
*
* @param other The {@link SemanticVersion} to use to compare.
* @return {@code true} if {@code this} {@link SemanticVersion} is before or matches the given {@link SemanticVersion}
* @since 1.2.0
*/
public boolean beforeOrMatches(SemanticVersion other) {
return before(other) || matches(other);
}
/**
* Compares {@code this} {@link SemanticVersion} with another {@link SemanticVersion}.
*
* @param other The {@link SemanticVersion} to use to compare.
* @return {@code true} if {@code this} {@link SemanticVersion} is before the given {@link SemanticVersion}
* @since 1.2.0
*/
public boolean before(SemanticVersion other) {
if (getMajorVersion().before(other.getMajorVersion())) {
return true;
} else if (getMajorVersion().matches(other.getMajorVersion())) {
if (getMinorVersion() != null && getMinorVersion().before(other.getMinorVersion())) {
return true;
} else if (getMinorVersion().matches(other.getMinorVersion())) {
if (getPatchVersion() != null && getPatchVersion().before(other.getPatchVersion())) {
return true;
}
}
}
return false;
}
/**
* Compares {@code this} {@link SemanticVersion} with another {@link SemanticVersion}.
*
* @param other The {@link SemanticVersion} to use to compare.
* @return {@code true} if {@code this} {@link SemanticVersion} is matches the given {@link SemanticVersion}
* @since 1.2.0
*/
public boolean matches(SemanticVersion other) {
return getVersionString().equals(other.getVersionString());
}
@Override
public String toString() {
return getVersionString();
}
/**
* Representation of the single token of a component version.
*
* @since 1.2.0
*/
static class VersionToken {
String versionString;
Integer versionInteger;
boolean integerComparison;
/**
* Constructor.
*
* @param versionToken The version token.
* @since 1.2.0
*/
VersionToken(String versionToken) {
try {
versionInteger = Integer.parseInt(versionToken);
integerComparison = true;
} catch (NumberFormatException e) {
versionInteger = null;
integerComparison = false;
}
versionString = versionToken;
}
/**
* Gets the {@link String} representation of the {@link VersionToken}.
*
* @return The {@link String} representation of the {@link VersionToken}.
* @since 1.2.0
*/
public String getVersionString() {
return versionString;
}
/**
* Gets the {@link Integer} representation of the {@link VersionToken}, if available.
*
* @return The {@link String} representation of the {@link VersionToken} or {@code null} if token is not a {@link Integer}.
* @since 1.2.0
*/
public Integer getVersionInteger() {
return versionInteger;
}
/**
* Returns whether or not {@code this} {@link VersionToken} can be compared as an {@link Integer}.
*
* @return {@true} if {@code this} {@link VersionToken} can be compared as a {@link Integer}, {@code false} otherwise.
*/
public boolean isIntegerComparison() {
return integerComparison;
}
/**
* Compares {@code this} {@link VersionToken} with another {@link VersionToken}.
*
* @param other The {@link VersionToken} to use to compare.
* @return {@code true} if {@code this} {@link VersionToken} is after the given {@link VersionToken}
* @since 1.2.0
*/
public boolean after(VersionToken other) {
if (isIntegerComparison() && other.isIntegerComparison()) {
return getVersionInteger() > other.getVersionInteger();
} else {
return getVersionString().compareTo(other.getVersionString()) > 0;
}
}
/**
* Compares {@code this} {@link VersionToken} with another {@link VersionToken}.
*
* @param other The {@link VersionToken} to use to compare.
* @return {@code true} if {@code this} {@link VersionToken} matches the given {@link VersionToken}
* @since 1.2.0
*/
public boolean matches(VersionToken other) {
if (isIntegerComparison() && other.isIntegerComparison()) {
return getVersionInteger().equals(other.getVersionInteger());
} else {
return getVersionString().compareTo(other.getVersionString()) == 0;
}
}
/**
* Compares {@code this} {@link VersionToken} with another {@link VersionToken}.
*
* @param other The {@link VersionToken} to use to compare.
* @return {@code true} if {@code this} {@link VersionToken} is before the given {@link VersionToken}
* @since 1.2.0
*/
public boolean before(VersionToken other) {
if (isIntegerComparison() && other.isIntegerComparison()) {
return getVersionInteger() < other.getVersionInteger();
} else {
return getVersionString().compareTo(other.getVersionString()) < 0;
}
}
@Override
public String toString() {
return getVersionString();
}
}
}