MF-5140 Adds @nullable & @nonnull annotations to generated data model…

… getters (#527)

* MF-5140 Adds @nullable & @nonnull annotations to generated data models

---------

Co-authored-by: Walter Dziemianczyk <[email protected]>

CHANGELOG.md

@@ -1,3 +1,6 @@
+6.1.0 (202X-XX-XX)
+---------------------------------------------
+- [#527](https://github.com/dropbox/dropbox-sdk-java/pull/527) Adds nullability annotations to data models for improved interop with Kotlin
 
 6.0.0 (2023-11-30)
 ---------------------------------------------

android/dependencies/releaseRuntimeClasspath.txt

@@ -1,6 +1,7 @@
 ch.randelshofer:fastdoubleparser:0.8.0
 com.fasterxml.jackson.core:jackson-core:2.15.0
 com.fasterxml.jackson:jackson-bom:2.15.0
+com.google.code.findbugs:jsr305:3.0.2
 org.jetbrains.kotlin:kotlin-stdlib-common:1.6.21
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.21
 org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21

core/build.gradle

@@ -56,6 +56,7 @@ sourceSets.main.java.srcDir(versionWriterTask)
 
 dependencies {
     api(dropboxJavaSdkLibs.jackson.core)
+    api(dropboxJavaSdkLibs.jsr305)
 
     compileOnly dropboxJavaSdkLibs.appengine.api
     compileOnly dropboxJavaSdkLibs.jakarta.servlet.api

core/build/generated_stone_source/main/src/com/dropbox/core/v2/account/SetProfilePhotoArg.java

@@ -16,9 +16,12 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 class SetProfilePhotoArg {
     // struct account.SetProfilePhotoArg (account.stone)
 
+    @Nonnull
     protected final PhotoSourceArg photo;
 
     /**
@@ -29,7 +32,7 @@ class SetProfilePhotoArg {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public SetProfilePhotoArg(PhotoSourceArg photo) {
+    public SetProfilePhotoArg(@Nonnull PhotoSourceArg photo) {
         if (photo == null) {
             throw new IllegalArgumentException("Required value for 'photo' is null");
         }
@@ -41,6 +44,7 @@ public SetProfilePhotoArg(PhotoSourceArg photo) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public PhotoSourceArg getPhoto() {
         return photo;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/account/SetProfilePhotoResult.java

@@ -16,9 +16,12 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 public class SetProfilePhotoResult {
     // struct account.SetProfilePhotoResult (account.stone)
 
+    @Nonnull
     protected final String profilePhotoUrl;
 
     /**
@@ -29,7 +32,7 @@ public class SetProfilePhotoResult {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public SetProfilePhotoResult(String profilePhotoUrl) {
+    public SetProfilePhotoResult(@Nonnull String profilePhotoUrl) {
         if (profilePhotoUrl == null) {
             throw new IllegalArgumentException("Required value for 'profilePhotoUrl' is null");
         }
@@ -41,6 +44,7 @@ public SetProfilePhotoResult(String profilePhotoUrl) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getProfilePhotoUrl() {
         return profilePhotoUrl;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/async/PollArg.java

@@ -16,12 +16,15 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 /**
  * Arguments for methods that poll the status of an asynchronous job.
  */
 public class PollArg {
     // struct async.PollArg (async.stone)
 
+    @Nonnull
     protected final String asyncJobId;
 
     /**
@@ -34,7 +37,7 @@ public class PollArg {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public PollArg(String asyncJobId) {
+    public PollArg(@Nonnull String asyncJobId) {
         if (asyncJobId == null) {
             throw new IllegalArgumentException("Required value for 'asyncJobId' is null");
         }
@@ -50,6 +53,7 @@ public PollArg(String asyncJobId) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getAsyncJobId() {
         return asyncJobId;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/auth/RateLimitError.java

@@ -16,12 +16,15 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 /**
  * Error occurred because the app is being rate limited.
  */
 public class RateLimitError {
     // struct auth.RateLimitError (auth.stone)
 
+    @Nonnull
     protected final RateLimitReason reason;
     protected final long retryAfter;
 
@@ -36,7 +39,7 @@ public class RateLimitError {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public RateLimitError(RateLimitReason reason, long retryAfter) {
+    public RateLimitError(@Nonnull RateLimitReason reason, long retryAfter) {
         if (reason == null) {
             throw new IllegalArgumentException("Required value for 'reason' is null");
         }
@@ -55,7 +58,7 @@ public RateLimitError(RateLimitReason reason, long retryAfter) {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public RateLimitError(RateLimitReason reason) {
+    public RateLimitError(@Nonnull RateLimitReason reason) {
         this(reason, 1L);
     }
 
@@ -64,6 +67,7 @@ public RateLimitError(RateLimitReason reason) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public RateLimitReason getReason() {
         return reason;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/auth/TokenFromOAuth1Arg.java

@@ -16,10 +16,14 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 class TokenFromOAuth1Arg {
     // struct auth.TokenFromOAuth1Arg (auth.stone)
 
+    @Nonnull
     protected final String oauth1Token;
+    @Nonnull
     protected final String oauth1TokenSecret;
 
     /**
@@ -32,7 +36,7 @@ class TokenFromOAuth1Arg {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public TokenFromOAuth1Arg(String oauth1Token, String oauth1TokenSecret) {
+    public TokenFromOAuth1Arg(@Nonnull String oauth1Token, @Nonnull String oauth1TokenSecret) {
         if (oauth1Token == null) {
             throw new IllegalArgumentException("Required value for 'oauth1Token' is null");
         }
@@ -54,6 +58,7 @@ public TokenFromOAuth1Arg(String oauth1Token, String oauth1TokenSecret) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getOauth1Token() {
         return oauth1Token;
     }
@@ -63,6 +68,7 @@ public String getOauth1Token() {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getOauth1TokenSecret() {
         return oauth1TokenSecret;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/auth/TokenFromOAuth1Result.java

@@ -16,9 +16,12 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 public class TokenFromOAuth1Result {
     // struct auth.TokenFromOAuth1Result (auth.stone)
 
+    @Nonnull
     protected final String oauth2Token;
 
     /**
@@ -29,7 +32,7 @@ public class TokenFromOAuth1Result {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public TokenFromOAuth1Result(String oauth2Token) {
+    public TokenFromOAuth1Result(@Nonnull String oauth2Token) {
         if (oauth2Token == null) {
             throw new IllegalArgumentException("Required value for 'oauth2Token' is null");
         }
@@ -44,6 +47,7 @@ public TokenFromOAuth1Result(String oauth2Token) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getOauth2Token() {
         return oauth2Token;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/auth/TokenScopeError.java

@@ -16,9 +16,12 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 public class TokenScopeError {
     // struct auth.TokenScopeError (auth.stone)
 
+    @Nonnull
     protected final String requiredScope;
 
     /**
@@ -29,7 +32,7 @@ public class TokenScopeError {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public TokenScopeError(String requiredScope) {
+    public TokenScopeError(@Nonnull String requiredScope) {
         if (requiredScope == null) {
             throw new IllegalArgumentException("Required value for 'requiredScope' is null");
         }
@@ -41,6 +44,7 @@ public TokenScopeError(String requiredScope) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getRequiredScope() {
         return requiredScope;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/check/EchoArg.java

@@ -16,12 +16,15 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 /**
  * Contains the arguments to be sent to the Dropbox servers.
  */
 class EchoArg {
     // struct check.EchoArg (check_api_v2_types.stone)
 
+    @Nonnull
     protected final String query;
 
     /**
@@ -33,7 +36,7 @@ class EchoArg {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public EchoArg(String query) {
+    public EchoArg(@Nonnull String query) {
         if (query == null) {
             throw new IllegalArgumentException("Required value for 'query' is null");
         }
@@ -58,6 +61,7 @@ public EchoArg() {
      * @return value for this field, or {@code null} if not present. Defaults to
      *     "".
      */
+    @Nonnull
     public String getQuery() {
         return query;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/check/EchoResult.java

@@ -16,12 +16,15 @@
 import java.io.IOException;
 import java.util.Arrays;
 
+import javax.annotation.Nonnull;
+
 /**
  * EchoResult contains the result returned from the Dropbox servers.
  */
 public class EchoResult {
     // struct check.EchoResult (check_api_v2_types.stone)
 
+    @Nonnull
     protected final String result;
 
     /**
@@ -33,7 +36,7 @@ public class EchoResult {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public EchoResult(String result) {
+    public EchoResult(@Nonnull String result) {
         if (result == null) {
             throw new IllegalArgumentException("Required value for 'result' is null");
         }
@@ -55,6 +58,7 @@ public EchoResult() {
      * @return value for this field, or {@code null} if not present. Defaults to
      *     "".
      */
+    @Nonnull
     public String getResult() {
         return result;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/common/RootInfo.java

@@ -17,13 +17,17 @@
 import java.util.Arrays;
 import java.util.regex.Pattern;
 
+import javax.annotation.Nonnull;
+
 /**
  * Information about current user's root.
  */
 public class RootInfo {
     // struct common.RootInfo (common.stone)
 
+    @Nonnull
     protected final String rootNamespaceId;
+    @Nonnull
     protected final String homeNamespaceId;
 
     /**
@@ -40,7 +44,7 @@ public class RootInfo {
      * @throws IllegalArgumentException  If any argument does not meet its
      *     preconditions.
      */
-    public RootInfo(String rootNamespaceId, String homeNamespaceId) {
+    public RootInfo(@Nonnull String rootNamespaceId, @Nonnull String homeNamespaceId) {
         if (rootNamespaceId == null) {
             throw new IllegalArgumentException("Required value for 'rootNamespaceId' is null");
         }
@@ -65,6 +69,7 @@ public RootInfo(String rootNamespaceId, String homeNamespaceId) {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getRootNamespaceId() {
         return rootNamespaceId;
     }
@@ -74,6 +79,7 @@ public String getRootNamespaceId() {
      *
      * @return value for this field, never {@code null}.
      */
+    @Nonnull
     public String getHomeNamespaceId() {
         return homeNamespaceId;
     }