Skip to content

Commit f63defb

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

File tree

126 files changed

+428
-16
lines changed

Some content is hidden

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

126 files changed

+428
-16
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,13 @@ static class ResolvedPathSource extends PathSource implements ModelSource {
175175
}
176176

177177
@Override
178+
@Nullable
178179
public Path getPath() {
179180
return null;
180181
}
181182

182183
@Override
184+
@Nullable
183185
public Source resolve(String relative) {
184186
return null;
185187
}

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

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

209209
@Override
210+
@Nullable
210211
public URL getURL() {
211212
return null;
212213
}

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

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

475475
@Override
476+
@Nullable
476477
public String attribute(@Nonnull String name) {
477478
return attributes.get(name);
478479
}
479480

480481
@Override
482+
@Nullable
481483
public XmlNode child(String name) {
482484
if (name != null) {
483485
ListIterator<XmlNode> it = children.listIterator(children.size());

‎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: 3 additions & 0 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,6 +93,7 @@ public VersionRange cloneOf() {
9293
* @return a new {@link VersionRange} object that represents the spec
9394
* @throws InvalidVersionSpecificationException if invalid version specification
9495
*/
96+
@Nullable
9597
public static VersionRange createFromVersionSpec(String spec) throws InvalidVersionSpecificationException {
9698
if (spec == null) {
9799
return null;
@@ -202,6 +204,7 @@ private static Restriction parseRestriction(String spec) throws InvalidVersionSp
202204
return restriction;
203205
}
204206

207+
@Nullable
205208
public static VersionRange createFromVersion(String version) {
206209
if (DefaultArtifact.empty(version)) {
207210
return null;

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

Lines changed: 2 additions & 0 deletions
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,6 +102,7 @@ public AuthenticationInfo getAuthenticationInfo(String id) {
101102
return new AuthenticationInfo();
102103
}
103104

105+
@Nullable
104106
public ProxyInfo getProxy(String protocol) {
105107
MavenSession session = legacySupport.getSession();
106108

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

Lines changed: 11 additions & 0 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,14 +252,17 @@ static class ArtifactRepositoryAdapter implements ArtifactRepository {
251252
this.repository = repository;
252253
}
253254

255+
@Nullable
254256
public String pathOf(org.apache.maven.artifact.Artifact artifact) {
255257
return null;
256258
}
257259

260+
@Nullable
258261
public String pathOfRemoteRepositoryMetadata(ArtifactMetadata artifactMetadata) {
259262
return null;
260263
}
261264

265+
@Nullable
262266
public String pathOfLocalRepositoryMetadata(ArtifactMetadata metadata, ArtifactRepository repository) {
263267
return null;
264268
}
@@ -269,6 +273,7 @@ public String getUrl() {
269273

270274
public void setUrl(String url) {}
271275

276+
@Nullable
272277
public String getBasedir() {
273278
return null;
274279
}
@@ -283,18 +288,21 @@ public String getId() {
283288

284289
public void setId(String id) {}
285290

291+
@Nullable
286292
public ArtifactRepositoryPolicy getSnapshots() {
287293
return null;
288294
}
289295

290296
public void setSnapshotUpdatePolicy(ArtifactRepositoryPolicy policy) {}
291297

298+
@Nullable
292299
public ArtifactRepositoryPolicy getReleases() {
293300
return null;
294301
}
295302

296303
public void setReleaseUpdatePolicy(ArtifactRepositoryPolicy policy) {}
297304

305+
@Nullable
298306
public ArtifactRepositoryLayout getLayout() {
299307
return null;
300308
}
@@ -315,6 +323,7 @@ public boolean isBlacklisted() {
315323

316324
public void setBlacklisted(boolean blackListed) {}
317325

326+
@Nullable
318327
public org.apache.maven.artifact.Artifact find(org.apache.maven.artifact.Artifact artifact) {
319328
return null;
320329
}
@@ -329,12 +338,14 @@ public boolean isProjectAware() {
329338

330339
public void setAuthentication(Authentication authentication) {}
331340

341+
@Nullable
332342
public Authentication getAuthentication() {
333343
return null;
334344
}
335345

336346
public void setProxy(Proxy proxy) {}
337347

348+
@Nullable
338349
public Proxy getProxy() {
339350
return null;
340351
}

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

Lines changed: 3 additions & 0 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,6 +59,7 @@ public String getArtifactId() {
5859
return artifact.getArtifactId();
5960
}
6061

62+
@Nullable
6163
public String getBaseVersion() {
6264
// Don't want the artifact's version in here, as this is stored in the directory above that
6365
return null;
@@ -93,6 +95,7 @@ private boolean isSnapshot(ArtifactVersion version) {
9395
return version != null && ArtifactUtils.isSnapshot(version.getQualifier());
9496
}
9597

98+
@Nullable
9699
public ArtifactRepository getRepository() {
97100
return null;
98101
}

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

Lines changed: 4 additions & 0 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,10 +49,12 @@ public String getGroupId() {
4849
return groupId;
4950
}
5051

52+
@Nullable
5153
public String getArtifactId() {
5254
return null;
5355
}
5456

57+
@Nullable
5558
public String getBaseVersion() {
5659
return null;
5760
}
@@ -87,6 +90,7 @@ public boolean isSnapshot() {
8790
return false;
8891
}
8992

93+
@Nullable
9094
public ArtifactRepository getRepository() {
9195
return null;
9296
}

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

Lines changed: 3 additions & 0 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,6 +87,7 @@ private String emptify(String string) {
8687
return (string != null) ? string : "";
8788
}
8889

90+
@Nullable
8991
public File getFile() {
9092
return null;
9193
}
@@ -95,6 +97,7 @@ public MetadataBridge setFile(File file) {
9597
}
9698

9799
@Override
100+
@Nullable
98101
public Path getPath() {
99102
return null;
100103
}

0 commit comments

Comments
 (0)