/
ArtifactVersions.java
258 lines (233 loc) · 7.71 KB
/
ArtifactVersions.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
package org.codehaus.mojo.versions.api;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import java.util.SortedSet;
import java.util.TreeSet;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.Restriction;
import org.apache.maven.artifact.versioning.VersionRange;
import org.codehaus.mojo.versions.ordering.VersionComparator;
import static org.apache.commons.lang3.StringUtils.compare;
/**
* Holds the results of a search for versions of an artifact.
*
* @author Stephen Connolly
* @since 1.0-alpha-3
*/
public class ArtifactVersions
extends AbstractVersionDetails implements Comparable<ArtifactVersions>
{
/**
* The artifact that who's versions we hold details of.
*
* @since 1.0-alpha-3
*/
private final Artifact artifact;
/**
* The available versions.
*
* @since 1.0-alpha-3
*/
private final SortedSet<ArtifactVersion> versions;
/**
* The version comparison rule that is used for this artifact.
*
* @since 1.0-alpha-3
*/
private final VersionComparator versionComparator;
/**
* Creates a new {@link ArtifactVersions} instance.
*
* @param artifact The artifact.
* @param versions The versions.
* @param versionComparator The version comparison rule.
* @since 1.0-alpha-3
*/
public ArtifactVersions( Artifact artifact, List<ArtifactVersion> versions, VersionComparator versionComparator )
{
this.artifact = artifact;
this.versionComparator = versionComparator;
this.versions = new TreeSet<>( versionComparator );
this.versions.addAll( versions );
// TODO owerwrite if null by version from elsewhere
if ( artifact.getVersion() != null )
{
setCurrentVersion( artifact.getVersion() );
}
}
/**
* Creates a new {@link ArtifactVersions} instance as shallow copy of the other
*
* @param other other object to be linked to
* @since 2.13.0
*/
public ArtifactVersions( ArtifactVersions other )
{
artifact = other.artifact;
versionComparator = other.versionComparator;
versions = other.versions;
setCurrentVersion( other.getCurrentVersion() );
setIncludeSnapshots( other.isIncludeSnapshots() );
}
@SuppressWarnings( "checkstyle:InnerAssignment" )
public int compareTo( ArtifactVersions that )
{
int rv;
return this == that
? 0
: that == null || getClass() != that.getClass()
? 1
: ( rv = compare( getGroupId(), that.getGroupId() ) ) != 0
? rv
: ( rv = compare( getArtifactId(), that.getArtifactId() ) ) != 0
? rv
: compare( getVersion(), that.getVersion() );
}
@Override
public boolean equals( Object o )
{
if ( this == o )
{
return true;
}
if ( !( o instanceof ArtifactVersions ) )
{
return false;
}
ArtifactVersions that = (ArtifactVersions) o;
return new EqualsBuilder()
.append( getArtifact(), that.getArtifact() )
.append( getVersions(), that.getVersions() )
.append( getVersionComparator(), that.getVersionComparator() )
.isEquals();
}
@Override
public int hashCode()
{
return new HashCodeBuilder( 17, 37 )
.append( getArtifact() )
.append( getVersions() )
.append( getVersionComparator() )
.toHashCode();
}
/**
* Checks if the version is in the range (and ensures that the range respects the <code>-!</code> syntax to rule out
* any qualifiers from range boundaries).
*
* @param version the version to check.
* @param range the range to check.
* @return <code>true</code> if and only if the version is in the range.
* @since 1.3
*/
public static boolean isVersionInRange( ArtifactVersion version, VersionRange range )
{
if ( !range.containsVersion( version ) )
{
return false;
}
for ( Restriction r : range.getRestrictions() )
{
if ( r.containsVersion( version ) )
{
// check for the -! syntax
if ( !r.isLowerBoundInclusive() && r.getLowerBound() != null )
{
String s = r.getLowerBound().toString();
if ( s.endsWith( "-!" ) && version.toString().startsWith( s.substring( 0, s.length() - 2 ) ) )
{
return false;
}
}
if ( !r.isUpperBoundInclusive() && r.getUpperBound() != null )
{
String s = r.getUpperBound().toString();
if ( s.endsWith( "-!" ) && version.toString().startsWith( s.substring( 0, s.length() - 2 ) ) )
{
return false;
}
}
}
}
return true;
}
/**
* Returns the artifact who's version information we are holding.
*
* @return the artifact who's version information we are holding.
* @since 1.0-alpha-3
*/
public Artifact getArtifact()
{
return artifact;
}
/**
* Returns the groupId of the artifact which versions we are holding.
*
* @return the groupId.
* @since 1.0-alpha-3
*/
public String getGroupId()
{
return getArtifact().getGroupId();
}
/**
* Returns the artifactId of the artifact which versions we are holding.
*
* @return the artifactId.
* @since 1.0-alpha-3
*/
public String getArtifactId()
{
return getArtifact().getArtifactId();
}
/**
* Returns the artifactId of the artifact which versions we are holding.
*
* @return current version
* @since 2.13.0
*/
public String getVersion()
{
return getArtifact().getVersion();
}
public ArtifactVersion[] getVersions( boolean includeSnapshots )
{
return includeSnapshots
? versions.toArray( new ArtifactVersion[0] )
: versions.stream().filter( v -> !ArtifactUtils.isSnapshot( v.toString() ) )
.toArray( ArtifactVersion[]::new );
}
public VersionComparator getVersionComparator()
{
return versionComparator;
}
/**
* {@inheritDoc}
*/
public String toString()
{
return "ArtifactVersions" + "{artifact=" + artifact + ", versions=" + versions + ", versionComparator="
+ versionComparator + '}';
}
}