SLING-7798 Switch from JSR-305 annotations to JetBrains Nullable/NotNull annotations
authorsseifert <sseifert@pro-vision.de>
Mon, 13 Aug 2018 09:20:48 +0000 (11:20 +0200)
committersseifert <sseifert@pro-vision.de>
Mon, 13 Aug 2018 09:20:48 +0000 (11:20 +0200)
pom.xml
src/main/java/org/apache/sling/distribution/DistributionRequest.java
src/main/java/org/apache/sling/distribution/DistributionRequestType.java
src/main/java/org/apache/sling/distribution/DistributionResponse.java
src/main/java/org/apache/sling/distribution/Distributor.java
src/main/java/org/apache/sling/distribution/SimpleDistributionRequest.java
src/main/java/org/apache/sling/distribution/package-info.java
src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecret.java
src/main/java/org/apache/sling/distribution/transport/DistributionTransportSecretProvider.java
src/main/java/org/apache/sling/distribution/transport/package-info.java

diff --git a/pom.xml b/pom.xml
index 240600d..b13b628 100644 (file)
--- a/pom.xml
+++ b/pom.xml
             <artifactId>org.osgi.compendium</artifactId>
         </dependency>
         <dependency>
-            <groupId>com.google.code.findbugs</groupId>
-            <artifactId>jsr305</artifactId>
-            <version>2.0.0</version>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>16.0.2</version>
             <scope>provided</scope>
         </dependency>
 
index 82af2ce..fe118c8 100644 (file)
  */
 package org.apache.sling.distribution;
 
-import javax.annotation.Nonnull;
-
 import aQute.bnd.annotation.ProviderType;
 
+import org.jetbrains.annotations.NotNull;
+
 /**
  * A {@link org.apache.sling.distribution.DistributionRequest} represents the need from the caller to have
  * some content being distributed from a source instance to a target instance.
@@ -35,7 +35,7 @@ public interface DistributionRequest {
      *
      * @return the type of the request as a {@link DistributionRequestType}
      */
-    @Nonnull
+    @NotNull
     DistributionRequestType getRequestType();
 
     /**
@@ -43,7 +43,7 @@ public interface DistributionRequest {
      *
      * @return an array of paths
      */
-    @Nonnull
+    @NotNull
     public String[] getPaths();
 
     /**
@@ -52,7 +52,7 @@ public interface DistributionRequest {
      * @param path the path to be checked
      * @return <code>true</code> if the paths are deep
      */
-    public boolean isDeep(@Nonnull String path);
+    public boolean isDeep(@NotNull String path);
 
 
 
@@ -65,6 +65,6 @@ public interface DistributionRequest {
      *
      * @return an array of filters
      */
-    @Nonnull
+    @NotNull
     public String[] getFilters(String path);
 }
index 6b44713..d01f28e 100644 (file)
@@ -20,7 +20,7 @@ package org.apache.sling.distribution;
 
 import aQute.bnd.annotation.ProviderType;
 
-import javax.annotation.CheckForNull;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * The request type tied to a specific {@link org.apache.sling.distribution.DistributionRequest}, used to decide how
@@ -62,7 +62,7 @@ public enum DistributionRequestType {
      * @param n the name
      * @return the type or {@code null}
      */
-    @CheckForNull
+    @Nullable
     public static DistributionRequestType fromName(String n) {
         if (n == null) {
             return null;
index bb7bf66..12f778c 100644 (file)
  */
 package org.apache.sling.distribution;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
-
 import aQute.bnd.annotation.ProviderType;
 
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
 /**
  * A {@link org.apache.sling.distribution.DistributionResponse} represents the outcome of a
  * {@link org.apache.sling.distribution.DistributionRequest} as handled by a certain distribution agent.
@@ -47,7 +47,7 @@ public interface DistributionResponse {
      *
      * @return the state of the associated request
      */
-    @Nonnull
+    @NotNull
     DistributionRequestState getState();
 
     /**
@@ -55,6 +55,6 @@ public interface DistributionResponse {
      * @return a message associated with this response holding information about
      * e.g. why distribution execution failed, etc.
      */
-    @CheckForNull
+    @Nullable
     String getMessage();
 }
index 4a714fa..192ff39 100644 (file)
@@ -21,8 +21,7 @@ package org.apache.sling.distribution;
 
 import aQute.bnd.annotation.ProviderType;
 import org.apache.sling.api.resource.ResourceResolver;
-
-import javax.annotation.Nonnull;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * A distributor is responsible for dispatching {@link org.apache.sling.distribution.DistributionRequest}s to distribution agents.
@@ -47,9 +46,9 @@ public interface Distributor {
      * @param resourceResolver    the resource resolver used for authorizing the request,
      * @return a {@link org.apache.sling.distribution.DistributionResponse}
      */
-    @Nonnull
-    DistributionResponse distribute(@Nonnull String agentName, @Nonnull ResourceResolver resourceResolver,
-                                    @Nonnull DistributionRequest distributionRequest);
+    @NotNull
+    DistributionResponse distribute(@NotNull String agentName, @NotNull ResourceResolver resourceResolver,
+                                    @NotNull DistributionRequest distributionRequest);
 
 
 }
index c5cce14..a1645fe 100644 (file)
@@ -20,12 +20,12 @@ package org.apache.sling.distribution;
 
 import aQute.bnd.annotation.ProviderType;
 
-import javax.annotation.Nonnull;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
+import org.jetbrains.annotations.NotNull;
 
 /**
  * A {@link SimpleDistributionRequest} is a {@link DistributionRequest} where all paths are either "deep" or "shallow".
@@ -45,7 +45,7 @@ public final class SimpleDistributionRequest implements DistributionRequest {
      * @param isDeep is <code>true</code> if all paths are "deep" and is <code>false</code> if all paths are "shallow"
      * @param paths the array of paths to be distributed
      */
-    public SimpleDistributionRequest(@Nonnull DistributionRequestType requestType, boolean isDeep, @Nonnull String... paths) {
+    public SimpleDistributionRequest(@NotNull DistributionRequestType requestType, boolean isDeep, @NotNull String... paths) {
         this(requestType, paths, isDeep? new HashSet<String>(Arrays.asList(paths)) : new HashSet<String>());
     }
 
@@ -54,7 +54,7 @@ public final class SimpleDistributionRequest implements DistributionRequest {
      * @param requestType the request type
      * @param paths the array of paths to be distributed
      */
-    public SimpleDistributionRequest(@Nonnull DistributionRequestType requestType, @Nonnull String... paths) {
+    public SimpleDistributionRequest(@NotNull DistributionRequestType requestType, @NotNull String... paths) {
         this(requestType, false, paths);
     }
 
@@ -65,7 +65,7 @@ public final class SimpleDistributionRequest implements DistributionRequest {
      * @param paths the array of paths to be distributed
      * @param deepPaths the set of paths that are to be distributed in depth (with all their children)
      */
-    public SimpleDistributionRequest(@Nonnull DistributionRequestType requestType, @Nonnull String[] paths, @Nonnull Set<String> deepPaths) {
+    public SimpleDistributionRequest(@NotNull DistributionRequestType requestType, @NotNull String[] paths, @NotNull Set<String> deepPaths) {
         this(requestType, paths, deepPaths, new HashMap<String, String[]>());
     }
 
@@ -77,7 +77,7 @@ public final class SimpleDistributionRequest implements DistributionRequest {
      * @param deepPaths the set of paths that are to be distributed in depth (with all their children)
      * @param pathFilters the filters applicable for each path
      */
-    public SimpleDistributionRequest(@Nonnull DistributionRequestType requestType, @Nonnull String[] paths, @Nonnull Set<String> deepPaths, @Nonnull Map<String, String[]> pathFilters) {
+    public SimpleDistributionRequest(@NotNull DistributionRequestType requestType, @NotNull String[] paths, @NotNull Set<String> deepPaths, @NotNull Map<String, String[]> pathFilters) {
         this.requestType = requestType;
         this.paths = paths;
         this.deepPaths = deepPaths;
@@ -89,7 +89,7 @@ public final class SimpleDistributionRequest implements DistributionRequest {
      *
      * @return the type of the request as a {@link DistributionRequestType}
      */
-    @Nonnull
+    @NotNull
     public DistributionRequestType getRequestType() {
         return requestType;
     }
@@ -108,11 +108,11 @@ public final class SimpleDistributionRequest implements DistributionRequest {
      * Returns whether the a path is covering the entire subtree (deep) or just the specified nodes (shallow)
      * @return <code>true</code> if the path is deep
      */
-    public boolean isDeep(@Nonnull String path) {
+    public boolean isDeep(@NotNull String path) {
         return deepPaths.contains(path);
     }
 
-    @Nonnull
+    @NotNull
     public String[] getFilters(String path) {
         String[] filters = pathFilters.get(path);
         return filters != null ? filters : new String[0];
index f91d309..5c2c564 100644 (file)
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-@Version("0.3.0")
+@Version("0.3.1")
 package org.apache.sling.distribution;
 
 import aQute.bnd.annotation.Version;
index b170c3c..9719531 100644 (file)
  */
 package org.apache.sling.distribution.transport;
 
-import javax.annotation.CheckForNull;
 import java.util.Map;
-
 import aQute.bnd.annotation.ConsumerType;
 
+import org.jetbrains.annotations.Nullable;
+
 /**
  * The secret to be transported for authenticating transport layer connecting two instances.
  * <p/>
@@ -39,7 +39,7 @@ public interface DistributionTransportSecret {
      * @return the credentials as a {@link java.util.Map}, or {@code null} if {@code secret} cannot be represented in terms
      * of a set of key -> value entries
      */
-    @CheckForNull
+    @Nullable
     Map<String, String> asCredentialsMap();
 
 }
index 289d275..7a1f5b2 100644 (file)
  */
 package org.apache.sling.distribution.transport;
 
-import javax.annotation.CheckForNull;
-
 import aQute.bnd.annotation.ConsumerType;
 
 import java.net.URI;
 
+import org.jetbrains.annotations.Nullable;
+
 /**
  * A provider for {@link org.apache.sling.distribution.transport.DistributionTransportSecret}s
  * <p/>
@@ -41,6 +41,6 @@ public interface DistributionTransportSecretProvider {
      * @return a {@link org.apache.sling.distribution.transport.DistributionTransportSecret secret}, or {@code null} if
      * that cannot be obtained
      */
-    @CheckForNull
+    @Nullable
     DistributionTransportSecret getSecret(URI uri);
 }
index 8005f31..822acfc 100644 (file)
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-@Version("0.1.0")
+@Version("0.1.1")
 package org.apache.sling.distribution.transport;
 
 import aQute.bnd.annotation.Version;