Skip to content

Commit ff4ea3b

Browse files
author
Vincent Potucek
committed
Add @nullable annotations throughout the codebase
1 parent f4c3fdd commit ff4ea3b

125 files changed

Lines changed: 434 additions & 294 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api/maven-api-core/src/main/java/org/apache/maven/api/services/Sources.java‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -175,18 +175,17 @@ static class ResolvedPathSource extends PathSource implements ModelSource {
175175
}
176176

177177
@Override
178-
public Path getPath() {
178+
public @Nullable Path getPath() {
179179
return null;
180180
}
181181

182182
@Override
183-
public Source resolve(String relative) {
183+
public @Nullable Source resolve(String relative) {
184184
return null;
185185
}
186186

187187
@Override
188-
@Nullable
189-
public ModelSource resolve(@Nonnull ModelLocator modelLocator, @Nonnull String relative) {
188+
public @Nullable ModelSource resolve(@Nonnull ModelLocator modelLocator, @Nonnull String relative) {
190189
return null;
191190
}
192191
}
@@ -225,8 +224,7 @@ public Source resolve(@Nonnull String relative) {
225224
}
226225

227226
@Override
228-
@Nullable
229-
public ModelSource resolve(@Nonnull ModelLocator locator, @Nonnull String relative) {
227+
public @Nullable ModelSource resolve(@Nonnull ModelLocator locator, @Nonnull String relative) {
230228
String norm = relative.replace('\\', File.separatorChar).replace('/', File.separatorChar);
231229
Path path = getPath().getParent().resolve(norm);
232230
Path relatedPom = locator.locateExistingPom(path);

‎api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/XmlReaderRequest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ public Path getRootDirectory() {
207207
}
208208

209209
@Override
210-
public URL getURL() {
210+
public @Nullable URL getURL() {
211211
return null;
212212
}
213213

‎api/maven-api-xml/src/main/java/org/apache/maven/api/xml/XmlNode.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -473,12 +473,12 @@ private record Impl(
473473
}
474474

475475
@Override
476-
public String attribute(@Nonnull String name) {
476+
public @Nullable String attribute(@Nonnull String name) {
477477
return attributes.get(name);
478478
}
479479

480480
@Override
481-
public XmlNode child(String name) {
481+
public @Nullable XmlNode child(String name) {
482482
if (name != null) {
483483
ListIterator<XmlNode> it = children.listIterator(children.size());
484484
while (it.hasPrevious()) {

‎compat/maven-artifact/pom.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ under the License.
4141
<artifactId>junit-jupiter-params</artifactId>
4242
<scope>test</scope>
4343
</dependency>
44+
<dependency>
45+
<groupId>org.apache.maven</groupId>
46+
<artifactId>maven-api-annotations</artifactId>
47+
</dependency>
4448
</dependencies>
4549

4650
<build>

‎compat/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/VersionRange.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import java.util.Objects;
2727
import java.util.WeakHashMap;
2828

29+
import org.apache.maven.api.annotations.Nullable;
2930
import org.apache.maven.artifact.Artifact;
3031
import org.apache.maven.artifact.DefaultArtifact;
3132

@@ -92,7 +93,8 @@ public VersionRange cloneOf() {
9293
* @return a new {@link VersionRange} object that represents the spec
9394
* @throws InvalidVersionSpecificationException if invalid version specification
9495
*/
95-
public static VersionRange createFromVersionSpec(String spec) throws InvalidVersionSpecificationException {
96+
public static @Nullable VersionRange createFromVersionSpec(String spec)
97+
throws InvalidVersionSpecificationException {
9698
if (spec == null) {
9799
return null;
98100
}
@@ -202,7 +204,7 @@ private static Restriction parseRestriction(String spec) throws InvalidVersionSp
202204
return restriction;
203205
}
204206

205-
public static VersionRange createFromVersion(String version) {
207+
public static @Nullable VersionRange createFromVersion(String version) {
206208
if (DefaultArtifact.empty(version)) {
207209
return null;
208210
}

‎compat/maven-compat/src/main/java/org/apache/maven/artifact/manager/DefaultWagonManager.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525
import java.util.List;
2626

27+
import org.apache.maven.api.annotations.Nullable;
2728
import org.apache.maven.artifact.Artifact;
2829
import org.apache.maven.artifact.repository.ArtifactRepository;
2930
import org.apache.maven.artifact.repository.ArtifactRepositoryFactory;
@@ -101,7 +102,7 @@ public AuthenticationInfo getAuthenticationInfo(String id) {
101102
return new AuthenticationInfo();
102103
}
103104

104-
public ProxyInfo getProxy(String protocol) {
105+
public @Nullable ProxyInfo getProxy(String protocol) {
105106
MavenSession session = legacySupport.getSession();
106107

107108
if (session != null && protocol != null) {

‎compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/LegacyLocalRepositoryManager.java‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import java.util.Objects;
2525

2626
import org.apache.maven.RepositoryUtils;
27+
import org.apache.maven.api.annotations.Nullable;
2728
import org.apache.maven.artifact.metadata.ArtifactMetadata;
2829
import org.apache.maven.artifact.repository.layout.ArtifactRepositoryLayout;
2930
import org.apache.maven.artifact.repository.layout.DefaultRepositoryLayout;
@@ -251,15 +252,16 @@ static class ArtifactRepositoryAdapter implements ArtifactRepository {
251252
this.repository = repository;
252253
}
253254

254-
public String pathOf(org.apache.maven.artifact.Artifact artifact) {
255+
public @Nullable String pathOf(org.apache.maven.artifact.Artifact artifact) {
255256
return null;
256257
}
257258

258-
public String pathOfRemoteRepositoryMetadata(ArtifactMetadata artifactMetadata) {
259+
public @Nullable String pathOfRemoteRepositoryMetadata(ArtifactMetadata artifactMetadata) {
259260
return null;
260261
}
261262

262-
public String pathOfLocalRepositoryMetadata(ArtifactMetadata metadata, ArtifactRepository repository) {
263+
public @Nullable String pathOfLocalRepositoryMetadata(
264+
ArtifactMetadata metadata, ArtifactRepository repository) {
263265
return null;
264266
}
265267

@@ -269,7 +271,7 @@ public String getUrl() {
269271

270272
public void setUrl(String url) {}
271273

272-
public String getBasedir() {
274+
public @Nullable String getBasedir() {
273275
return null;
274276
}
275277

@@ -283,19 +285,19 @@ public String getId() {
283285

284286
public void setId(String id) {}
285287

286-
public ArtifactRepositoryPolicy getSnapshots() {
288+
public @Nullable ArtifactRepositoryPolicy getSnapshots() {
287289
return null;
288290
}
289291

290292
public void setSnapshotUpdatePolicy(ArtifactRepositoryPolicy policy) {}
291293

292-
public ArtifactRepositoryPolicy getReleases() {
294+
public @Nullable ArtifactRepositoryPolicy getReleases() {
293295
return null;
294296
}
295297

296298
public void setReleaseUpdatePolicy(ArtifactRepositoryPolicy policy) {}
297299

298-
public ArtifactRepositoryLayout getLayout() {
300+
public @Nullable ArtifactRepositoryLayout getLayout() {
299301
return null;
300302
}
301303

@@ -315,7 +317,7 @@ public boolean isBlacklisted() {
315317

316318
public void setBlacklisted(boolean blackListed) {}
317319

318-
public org.apache.maven.artifact.Artifact find(org.apache.maven.artifact.Artifact artifact) {
320+
public @Nullable org.apache.maven.artifact.Artifact find(org.apache.maven.artifact.Artifact artifact) {
319321
return null;
320322
}
321323

@@ -329,13 +331,13 @@ public boolean isProjectAware() {
329331

330332
public void setAuthentication(Authentication authentication) {}
331333

332-
public Authentication getAuthentication() {
334+
public @Nullable Authentication getAuthentication() {
333335
return null;
334336
}
335337

336338
public void setProxy(Proxy proxy) {}
337339

338-
public Proxy getProxy() {
340+
public @Nullable Proxy getProxy() {
339341
return null;
340342
}
341343

‎compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/ArtifactRepositoryMetadata.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.apache.maven.artifact.repository.metadata;
2020

21+
import org.apache.maven.api.annotations.Nullable;
2122
import org.apache.maven.artifact.Artifact;
2223
import org.apache.maven.artifact.ArtifactUtils;
2324
import org.apache.maven.artifact.repository.ArtifactRepository;
@@ -58,7 +59,7 @@ public String getArtifactId() {
5859
return artifact.getArtifactId();
5960
}
6061

61-
public String getBaseVersion() {
62+
public @Nullable String getBaseVersion() {
6263
// Don't want the artifact's version in here, as this is stored in the directory above that
6364
return null;
6465
}
@@ -93,7 +94,7 @@ private boolean isSnapshot(ArtifactVersion version) {
9394
return version != null && ArtifactUtils.isSnapshot(version.getQualifier());
9495
}
9596

96-
public ArtifactRepository getRepository() {
97+
public @Nullable ArtifactRepository getRepository() {
9798
return null;
9899
}
99100

‎compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/GroupRepositoryMetadata.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import java.util.Iterator;
2222
import java.util.List;
2323

24+
import org.apache.maven.api.annotations.Nullable;
2425
import org.apache.maven.artifact.repository.ArtifactRepository;
2526

2627
/**
@@ -48,11 +49,11 @@ public String getGroupId() {
4849
return groupId;
4950
}
5051

51-
public String getArtifactId() {
52+
public @Nullable String getArtifactId() {
5253
return null;
5354
}
5455

55-
public String getBaseVersion() {
56+
public @Nullable String getBaseVersion() {
5657
return null;
5758
}
5859

@@ -87,7 +88,7 @@ public boolean isSnapshot() {
8788
return false;
8889
}
8990

90-
public ArtifactRepository getRepository() {
91+
public @Nullable ArtifactRepository getRepository() {
9192
return null;
9293
}
9394

‎compat/maven-compat/src/main/java/org/apache/maven/artifact/repository/metadata/MetadataBridge.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import java.util.Collections;
2525
import java.util.Map;
2626

27+
import org.apache.maven.api.annotations.Nullable;
2728
import org.apache.maven.artifact.metadata.ArtifactMetadata;
2829
import org.apache.maven.artifact.repository.ArtifactRepository;
2930
import org.apache.maven.artifact.repository.DefaultArtifactRepository;
@@ -86,7 +87,7 @@ private String emptify(String string) {
8687
return (string != null) ? string : "";
8788
}
8889

89-
public File getFile() {
90+
public @Nullable File getFile() {
9091
return null;
9192
}
9293

@@ -95,7 +96,7 @@ public MetadataBridge setFile(File file) {
9596
}
9697

9798
@Override
98-
public Path getPath() {
99+
public @Nullable Path getPath() {
99100
return null;
100101
}
101102

0 commit comments

Comments
 (0)