MF-5140 Adds @Nullable & @Nonnull annotations to generated data model getters

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
@@ -313,8 +314,8 @@ tasks.named("generateStone", StoneTask) {
 
     ])
     outputDir.set(project.layout.buildDirectory.dir("generated_stone_source/main"))
-    sourceSets { main { java.srcDir(outputDir.file("src")) } }
 }
+sourceSets.main.java.srcDir(generateStone)
 
 tasks.named("generateTestStone", StoneTask) {
     String packageName = 'com.dropbox.core.stone'
@@ -333,8 +334,8 @@ tasks.named("generateTestStone", StoneTask) {
             ),
     ])
     outputDir.set(project.layout.buildDirectory.dir("generated_stone_source/test"))
-    sourceSets { test { java.srcDir(outputDir.file("src")) } }
 }
+sourceSets.test.java.srcDir(generateTestStone)
 
 mavenPublishing {
     publishToMavenCentral(SonatypeHost.S01)

core/build/generated_stone_source/main/src/com/dropbox/core/DbxSdkVersion.java

@@ -0,0 +1,6 @@
+// Generated file. Do not edit
+package com.dropbox.core;
+
+public final class DbxSdkVersion {
+    public static final String Version = "6.1.0-SNAPSHOT";
+}

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

@@ -41,6 +41,7 @@ public SetProfilePhotoArg(PhotoSourceArg photo) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public PhotoSourceArg getPhoto() {
         return photo;
     }

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

@@ -41,6 +41,7 @@ public SetProfilePhotoResult(String profilePhotoUrl) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getProfilePhotoUrl() {
         return profilePhotoUrl;
     }

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

@@ -50,6 +50,7 @@ public PollArg(String asyncJobId) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getAsyncJobId() {
         return asyncJobId;
     }

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

@@ -64,6 +64,7 @@ public RateLimitError(RateLimitReason reason) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public RateLimitReason getReason() {
         return reason;
     }

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

@@ -54,6 +54,7 @@ public TokenFromOAuth1Arg(String oauth1Token, String oauth1TokenSecret) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getOauth1Token() {
         return oauth1Token;
     }
@@ -63,6 +64,7 @@ public String getOauth1Token() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getOauth1TokenSecret() {
         return oauth1TokenSecret;
     }

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

@@ -44,6 +44,7 @@ public TokenFromOAuth1Result(String oauth2Token) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getOauth2Token() {
         return oauth2Token;
     }

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

@@ -41,6 +41,7 @@ public TokenScopeError(String requiredScope) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getRequiredScope() {
         return requiredScope;
     }

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

@@ -58,6 +58,7 @@ public EchoArg() {
      * @return value for this field, or {@code null} if not present. Defaults to
      *     "".
      */
+    @javax.annotation.Nonnull
     public String getQuery() {
         return query;
     }

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

@@ -55,6 +55,7 @@ public EchoResult() {
      * @return value for this field, or {@code null} if not present. Defaults to
      *     "".
      */
+    @javax.annotation.Nonnull
     public String getResult() {
         return result;
     }

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

@@ -65,6 +65,7 @@ public RootInfo(String rootNamespaceId, String homeNamespaceId) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getRootNamespaceId() {
         return rootNamespaceId;
     }
@@ -74,6 +75,7 @@ public String getRootNamespaceId() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getHomeNamespaceId() {
         return homeNamespaceId;
     }

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

@@ -58,6 +58,7 @@ public TeamRootInfo(String rootNamespaceId, String homeNamespaceId, String homeP
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getRootNamespaceId() {
         return rootNamespaceId;
     }
@@ -67,6 +68,7 @@ public String getRootNamespaceId() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getHomeNamespaceId() {
         return homeNamespaceId;
     }
@@ -76,6 +78,7 @@ public String getHomeNamespaceId() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getHomePath() {
         return homePath;
     }

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

@@ -51,6 +51,7 @@ public UserRootInfo(String rootNamespaceId, String homeNamespaceId) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getRootNamespaceId() {
         return rootNamespaceId;
     }
@@ -60,6 +61,7 @@ public String getRootNamespaceId() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getHomeNamespaceId() {
         return homeNamespaceId;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/contacts/DeleteManualContactsArg.java

@@ -53,6 +53,7 @@ public DeleteManualContactsArg(List<String> emailAddresses) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<String> getEmailAddresses() {
         return emailAddresses;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/AddPropertiesArg.java

@@ -61,6 +61,7 @@ public AddPropertiesArg(String path, List<PropertyGroup> propertyGroups) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getPath() {
         return path;
     }
@@ -71,6 +72,7 @@ public String getPath() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<PropertyGroup> getPropertyGroups() {
         return propertyGroups;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/AddTemplateArg.java

@@ -42,6 +42,7 @@ public AddTemplateArg(String name, String description, List<PropertyFieldTemplat
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getName() {
         return name;
     }
@@ -52,6 +53,7 @@ public String getName() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getDescription() {
         return description;
     }
@@ -62,6 +64,7 @@ public String getDescription() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<PropertyFieldTemplate> getFields() {
         return fields;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/AddTemplateResult.java

@@ -55,6 +55,7 @@ public AddTemplateResult(String templateId) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getTemplateId() {
         return templateId;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/GetTemplateArg.java

@@ -55,6 +55,7 @@ public GetTemplateArg(String templateId) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getTemplateId() {
         return templateId;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/GetTemplateResult.java

@@ -42,6 +42,7 @@ public GetTemplateResult(String name, String description, List<PropertyFieldTemp
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getName() {
         return name;
     }
@@ -52,6 +53,7 @@ public String getName() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getDescription() {
         return description;
     }
@@ -62,6 +64,7 @@ public String getDescription() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<PropertyFieldTemplate> getFields() {
         return fields;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/ListTemplateResult.java

@@ -60,6 +60,7 @@ public ListTemplateResult(List<String> templateIds) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<String> getTemplateIds() {
         return templateIds;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/OverwritePropertyGroupArg.java

@@ -64,6 +64,7 @@ public OverwritePropertyGroupArg(String path, List<PropertyGroup> propertyGroups
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getPath() {
         return path;
     }
@@ -74,6 +75,7 @@ public String getPath() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<PropertyGroup> getPropertyGroups() {
         return propertyGroups;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/PropertiesSearchArg.java

@@ -72,6 +72,7 @@ public PropertiesSearchArg(List<PropertiesSearchQuery> queries) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<PropertiesSearchQuery> getQueries() {
         return queries;
     }
@@ -83,6 +84,7 @@ public List<PropertiesSearchQuery> getQueries() {
      * @return value for this field, or {@code null} if not present. Defaults to
      *     TemplateFilter.FILTER_NONE.
      */
+    @javax.annotation.Nonnull
     public TemplateFilter getTemplateFilter() {
         return templateFilter;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/PropertiesSearchContinueArg.java

@@ -50,6 +50,7 @@ public PropertiesSearchContinueArg(String cursor) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getCursor() {
         return cursor;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/PropertiesSearchMatch.java

@@ -67,6 +67,7 @@ public PropertiesSearchMatch(String id, String path, boolean isDeleted, List<Pro
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getId() {
         return id;
     }
@@ -76,6 +77,7 @@ public String getId() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getPath() {
         return path;
     }
@@ -94,6 +96,7 @@ public boolean getIsDeleted() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<PropertyGroup> getPropertyGroups() {
         return propertyGroups;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/PropertiesSearchQuery.java

@@ -72,6 +72,7 @@ public PropertiesSearchQuery(String query, PropertiesSearchMode mode) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public String getQuery() {
         return query;
     }
@@ -81,6 +82,7 @@ public String getQuery() {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public PropertiesSearchMode getMode() {
         return mode;
     }
@@ -91,6 +93,7 @@ public PropertiesSearchMode getMode() {
      * @return value for this field, or {@code null} if not present. Defaults to
      *     LogicalOperator.OR_OPERATOR.
      */
+    @javax.annotation.Nonnull
     public LogicalOperator getLogicalOperator() {
         return logicalOperator;
     }

core/build/generated_stone_source/main/src/com/dropbox/core/v2/fileproperties/PropertiesSearchResult.java

@@ -73,6 +73,7 @@ public PropertiesSearchResult(List<PropertiesSearchMatch> matches) {
      *
      * @return value for this field, never {@code null}.
      */
+    @javax.annotation.Nonnull
     public List<PropertiesSearchMatch> getMatches() {
         return matches;
     }
@@ -85,6 +86,7 @@ public List<PropertiesSearchMatch> getMatches() {
      *
      * @return value for this field, or {@code null} if not present.
      */
+    @javax.annotation.Nullable
     public String getCursor() {
         return cursor;
     }