Add nullability annotations to parser plugins (#827)

Author: seadowg

build.gradle

@@ -110,23 +110,33 @@ if (!project.hasProperty("android")) {
         namespace 'com.example'
 
         compileSdkVersion 34
+
         defaultConfig {
             minSdkVersion 21
             targetSdkVersion 33
             versionCode 1
             versionName "1.0"
             testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         }
+
         compileOptions {
             coreLibraryDesugaringEnabled true
             sourceCompatibility JavaVersion.VERSION_1_8
             targetCompatibility JavaVersion.VERSION_1_8
         }
+
         buildTypes {
             release {
                 minifyEnabled false
             }
         }
+
+        configurations.configureEach {
+            resolutionStrategy {
+                // Fix mismatch with kotlin-stdlib
+                force 'org.jetbrains:annotations:26.0.2'
+            }
+        }
     }
 }
 
@@ -138,6 +148,7 @@ dependencies {
     api 'org.jetbrains.kotlin:kotlin-stdlib:1.6.10'
     api 'org.bouncycastle:bcprov-jdk18on:1.77'
     api 'net.sf.kxml:kxml2:2.3.0'
+    compileOnly 'org.jetbrains:annotations:26.0.2'
 
     // Upgrade to version higher than 1.4 when Collect minSDK >= 26
     api 'org.apache.commons:commons-csv:1.4'
@@ -149,4 +160,5 @@ dependencies {
     testImplementation 'junit:junit:4.13.2'
     testImplementation 'net.sf.kxml:kxml2:2.3.0'
     testImplementation 'org.hamcrest:hamcrest-all:1.3'
+    testCompileOnly 'org.jetbrains:annotations:26.0.2'
 }

pom.xml

@@ -101,6 +101,12 @@
       <artifactId>hamcrest-all</artifactId>
       <version>1.3</version>
     </dependency>
+    <dependency>
+      <groupId>org.jetbrains</groupId>
+      <artifactId>annotations</artifactId>
+      <version>26.0.2</version>
+      <scope>provided</scope>
+    </dependency>
   </dependencies>
   <build>
     <plugins>

src/main/java/org/javarosa/xform/parse/XFormParser.java

@@ -2491,16 +2491,16 @@ public interface FormDefProcessor extends Processor {
 
     public interface BindAttributeProcessor extends Processor {
 
-        Set<Pair<String, String>> getBindAttributes();
+        @NotNull Set<@NotNull Pair<@NotNull String, @NotNull String>> getBindAttributes();
 
-        void processBindAttribute(String name, String value, DataBinding binding);
+        void processBindAttribute(@NotNull String name, @NotNull String value, @NotNull DataBinding binding);
     }
 
     public interface ModelAttributeProcessor extends Processor {
 
-        Set<Pair<String, String>> getModelAttributes();
+        @NotNull Set<@NotNull Pair<@NotNull String, @NotNull String>> getModelAttributes();
 
-        void processModelAttribute(String name, String value) throws ParseException;
+        void processModelAttribute(@NotNull String name, @NotNull String value) throws ParseException;
     }
 
     public interface QuestionProcessor extends Processor {

src/test/java/org/javarosa/xform/parse/BindAttributeProcessorTest.java

@@ -7,6 +7,7 @@
 import org.javarosa.core.model.instance.TreeReference;
 import org.javarosa.test.XFormsElement;
 import org.javarosa.model.xform.XPathReference;
+import org.jetbrains.annotations.NotNull;
 import org.junit.Test;
 
 import java.io.ByteArrayInputStream;
@@ -105,12 +106,12 @@ public RecordingBindAttributeProcessor(Set<Pair<String, String>> attributes) {
         }
 
         @Override
-        public Set<Pair<String, String>> getBindAttributes() {
+        public @NotNull Set<@NotNull Pair<@NotNull String, @NotNull String>> getBindAttributes() {
             return attributes;
         }
 
         @Override
-        public void processBindAttribute(String name, String value, DataBinding binding) {
+        public void processBindAttribute(@NotNull String name, @NotNull String value, @NotNull DataBinding binding) {
             processCalled = true;
         }
     }