You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by kw...@apache.org on 2022/05/27 14:43:08 UTC

[jackrabbit-filevault] branch master updated: trivial: add mising null annotations

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git


The following commit(s) were added to refs/heads/master by this push:
     new 0bb50eec trivial: add mising null annotations
0bb50eec is described below

commit 0bb50eec74fd74400d6be1937259ae74f70f0e5d
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri May 27 16:43:02 2022 +0200

    trivial: add mising null annotations
---
 .../validation/context/AbstractDependencyResolver.java  | 14 +++++++-------
 .../validation/context/ArchiveValidationContext.java    | 17 +++++++++--------
 .../context/SubPackageInArchiveValidationContext.java   |  3 ++-
 .../vault/validation/context/package-info.java          |  2 +-
 4 files changed, 19 insertions(+), 17 deletions(-)

diff --git a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/AbstractDependencyResolver.java b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/AbstractDependencyResolver.java
index d91c8cac..15eb1550 100644
--- a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/AbstractDependencyResolver.java
+++ b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/AbstractDependencyResolver.java
@@ -35,7 +35,7 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * Abstract resolver supporting Maven repository dependency location URIs (starting with {@code maven}:).
+ * Abstract resolver supporting Maven repository dependency location URIs (starting with {@code maven:}).
  * All package dependencies are mapped to Maven coordinates by this class and then resolved via {@link #resolvePackageInfo(MavenCoordinates)}.
  * It comes with a cache so that the same package dependency is not resolved more than once.
  * This class is not thread-safe.
@@ -50,12 +50,12 @@ public abstract class AbstractDependencyResolver implements DependencyResolver {
     public static final String MAVEN_REPOSITORY_SCHEME = "maven";
     private final Collection<PackageInfo> packageInfoCache;
 
-    protected AbstractDependencyResolver(Collection<PackageInfo> packageInfoCache) {
+    protected AbstractDependencyResolver(@NotNull Collection<PackageInfo> packageInfoCache) {
         this.packageInfoCache = new LinkedList<>(packageInfoCache);
     }
 
     @Override
-    public Collection<PackageInfo> resolvePackageInfo(Dependency[] dependencies, Map<PackageId, URI> dependencyLocations) throws IOException {
+    public @NotNull Collection<PackageInfo> resolvePackageInfo(@NotNull Dependency[] dependencies, @NotNull Map<PackageId, URI> dependencyLocations) throws IOException {
         List<PackageInfo> packageInfos = new LinkedList<>();
         // resolve dependencies
         for (Dependency dependency : dependencies) {
@@ -95,7 +95,7 @@ public abstract class AbstractDependencyResolver implements DependencyResolver {
      * @return the resolved package info or {@code null}
      * @throws IOException
      */
-    private @Nullable PackageInfo resolvePackageInfo(Dependency dependency) throws IOException {
+    private @Nullable PackageInfo resolvePackageInfo(@NotNull Dependency dependency) throws IOException {
         // resolving a version range is not supported with Maven API, but only with lower level Aether API (requires Maven 3.5 or newer)
         // https://github.com/eclipse/aether-demo/blob/master/aether-demo-snippets/src/main/java/org/eclipse/aether/examples/FindAvailableVersions.java
         // therefore do an best effort resolve instead
@@ -129,11 +129,11 @@ public abstract class AbstractDependencyResolver implements DependencyResolver {
 
         private static final String DEFAULT_PACKAGING = "zip";
 
-        public MavenCoordinates(String groupId, String artifactId, String version) {
+        public MavenCoordinates(@NotNull String groupId, @NotNull String artifactId, String version) {
             this(groupId, artifactId, version, DEFAULT_PACKAGING, null);
         }
 
-        public MavenCoordinates(String groupId, String artifactId, String version, String packaging, String classifier) {
+        public MavenCoordinates(@NotNull String groupId, @NotNull String artifactId, String version,@NotNull String packaging, String classifier) {
             super();
             this.groupId = groupId;
             this.artifactId = artifactId;
@@ -142,7 +142,7 @@ public abstract class AbstractDependencyResolver implements DependencyResolver {
             this.classifier = classifier;
         }
 
-        public static MavenCoordinates parse(URI uri) {
+        public static @Nullable MavenCoordinates parse(URI uri) {
             if (!MAVEN_REPOSITORY_SCHEME.equals(uri.getScheme())) {
                 return null;
             }
diff --git a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/ArchiveValidationContext.java b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/ArchiveValidationContext.java
index 34168044..5a0d592e 100644
--- a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/ArchiveValidationContext.java
+++ b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/ArchiveValidationContext.java
@@ -25,6 +25,7 @@ import org.apache.jackrabbit.vault.fs.io.Archive;
 import org.apache.jackrabbit.vault.packaging.PackageInfo;
 import org.apache.jackrabbit.vault.packaging.PackageProperties;
 import org.apache.jackrabbit.vault.validation.spi.ValidationContext;
+import org.jetbrains.annotations.NotNull;
 
 
 /**
@@ -33,11 +34,11 @@ import org.apache.jackrabbit.vault.validation.spi.ValidationContext;
 public class ArchiveValidationContext implements ValidationContext {
 
     private final WorkspaceFilter filter;
-    private final PackageProperties properties;
-    private final Path archivePath;
-    private final Collection<PackageInfo> resolvedDependencies;
+    @NotNull private final PackageProperties properties;
+    @NotNull private final Path archivePath;
+    @NotNull private final Collection<PackageInfo> resolvedDependencies;
 
-    public ArchiveValidationContext(Archive archive, Path archivePath, DependencyResolver resolver) throws IOException {
+    public ArchiveValidationContext(@NotNull Archive archive, @NotNull Path archivePath, @NotNull DependencyResolver resolver) throws IOException {
         this.archivePath = archivePath;
         properties = archive.getMetaInf().getPackageProperties();
         this.filter = archive.getMetaInf().getFilter();
@@ -48,12 +49,12 @@ public class ArchiveValidationContext implements ValidationContext {
     }
 
     @Override
-    public PackageProperties getProperties() {
+    public @NotNull PackageProperties getProperties() {
         return properties;
     }
 
     @Override
-    public WorkspaceFilter getFilter() {
+    public @NotNull WorkspaceFilter getFilter() {
         return filter;
     }
 
@@ -62,12 +63,12 @@ public class ArchiveValidationContext implements ValidationContext {
         return null;
     }
 
-    public Path getPackageRootPath() {
+    public @NotNull Path getPackageRootPath() {
         return archivePath;
     }
 
     @Override
-    public Collection<PackageInfo> getDependenciesPackageInfo() {
+    public @NotNull Collection<PackageInfo> getDependenciesPackageInfo() {
         return this.resolvedDependencies;
     }
 
diff --git a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/SubPackageInArchiveValidationContext.java b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/SubPackageInArchiveValidationContext.java
index ca14c5c9..1584e0ce 100644
--- a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/SubPackageInArchiveValidationContext.java
+++ b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/SubPackageInArchiveValidationContext.java
@@ -21,6 +21,7 @@ import java.nio.file.Path;
 
 import org.apache.jackrabbit.vault.fs.io.Archive;
 import org.apache.jackrabbit.vault.validation.spi.ValidationContext;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * Implements a {@link ValidationContext} based on a sub package given through an {@link Archive}.
@@ -29,7 +30,7 @@ public class SubPackageInArchiveValidationContext extends ArchiveValidationConte
 
     private final ValidationContext containerPackageContext;
 
-    public SubPackageInArchiveValidationContext(ArchiveValidationContext containerPackageContext, Archive archive, Path archivePath, DependencyResolver resolver) throws IOException {
+    public SubPackageInArchiveValidationContext(@NotNull ArchiveValidationContext containerPackageContext, @NotNull Archive archive, @NotNull Path archivePath, @NotNull DependencyResolver resolver) throws IOException {
         super(archive, archivePath, resolver);
         this.containerPackageContext = containerPackageContext;
     }
diff --git a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/package-info.java b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/package-info.java
index 0b7b1f4b..11a8500c 100644
--- a/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/package-info.java
+++ b/vault-validation/src/main/java/org/apache/jackrabbit/vault/validation/context/package-info.java
@@ -17,7 +17,7 @@
 /**
  * Provides common implementations of {@link org.apache.jackrabbit.vault.validation.spi.ValidationContext}
  */
-@Version("1.0.0")
+@Version("1.0.1")
 package org.apache.jackrabbit.vault.validation.context;
 
 import org.osgi.annotation.versioning.Version;