Merge pull request #94 from therepanic/migrate-nullability-annotations-to-jspecify

Migrate nullability annotations to jspecify

Author: therepanic

client/build.gradle

@@ -5,6 +5,7 @@ plugins {
 dependencies {
     implementation project(":utils")
     implementation libs.okhttp
+    compileOnly libs.jspecify
     testImplementation libs.mockwebserver
     implementation libs.gson
     implementation libs.jsoup
@@ -25,12 +26,6 @@ java {
     }
 }
 
-tasks.withType(Javadoc).configureEach {
-    failOnError = true
-    options.addStringOption('Xdoclint:all', '-quiet')
-    options.addBooleanOption('Xwerror', true)
-}
-
 tasks.named("build") {
     dependsOn(javadoc)
 }

client/src/main/java/com/therepanic/funpay4j/client/OkHttpFunPayClient.java

@@ -18,7 +18,6 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
-import lombok.NonNull;
 import okhttp3.MultipartBody;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
@@ -40,24 +39,24 @@
  * @since 1.0.3
  */
 public class OkHttpFunPayClient implements FunPayClient {
-    @NonNull private final OkHttpClient httpClient;
+    private final OkHttpClient httpClient;
 
-    @NonNull private final String baseURL;
+    private final String baseURL;
 
     /**
      * Creates a new OkHttpFunPayClient instance
      *
      * @param httpClient httpClient required to send http requests
      * @param baseURL base URL of the primary server
      */
-    public OkHttpFunPayClient(@NonNull OkHttpClient httpClient, @NonNull String baseURL) {
+    public OkHttpFunPayClient(OkHttpClient httpClient, String baseURL) {
         this.httpClient = httpClient;
         this.baseURL = baseURL;
     }
 
     /** {@inheritDoc} */
     @Override
-    public void updateAvatar(@NonNull String goldenKey, byte @NonNull [] newAvatar)
+    public void updateAvatar(String goldenKey, byte[] newAvatar)
             throws FunPayApiException, InvalidGoldenKeyException {
         RequestBody requestBody =
                 new MultipartBody.Builder()
@@ -85,7 +84,7 @@ public void updateAvatar(@NonNull String goldenKey, byte @NonNull [] newAvatar)
 
     /** {@inheritDoc} */
     @Override
-    public void raiseAllOffers(@NonNull String goldenKey, long gameId, long lotId)
+    public void raiseAllOffers(String goldenKey, long gameId, long lotId)
             throws FunPayApiException, InvalidGoldenKeyException, OfferAlreadyRaisedException {
         RequestBody requestBody =
                 new MultipartBody.Builder()
@@ -123,10 +122,7 @@ public void raiseAllOffers(@NonNull String goldenKey, long gameId, long lotId)
     /** {@inheritDoc} */
     @Override
     public void saveOffer(
-            @NonNull String goldenKey,
-            @NonNull String csrfToken,
-            @NonNull String phpSessionId,
-            @NonNull SaveOfferRequest request)
+            String goldenKey, String csrfToken, String phpSessionId, SaveOfferRequest request)
             throws FunPayApiException, InvalidGoldenKeyException {
         MultipartBody.Builder multipartBody =
                 new MultipartBody.Builder()
@@ -249,7 +245,7 @@ public void saveOffer(
 
     /** {@inheritDoc} */
     @Override
-    public Long addOfferImage(@NonNull String goldenKey, byte @NonNull [] image)
+    public Long addOfferImage(String goldenKey, byte[] image)
             throws FunPayApiException, InvalidGoldenKeyException {
         RequestBody requestBody =
                 new MultipartBody.Builder()

client/src/main/java/com/therepanic/funpay4j/client/package-info.java

@@ -0,0 +1,16 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+@org.jspecify.annotations.NullMarked
+package com.therepanic.funpay4j.client;

client/src/main/java/com/therepanic/funpay4j/objects/transaction/ParsedTransaction.java

@@ -20,7 +20,7 @@
 import lombok.Builder;
 import lombok.Data;
 
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * This object represents the parsed FunPay transaction

client/src/main/java/com/therepanic/funpay4j/objects/user/ParsedPreviewUser.java

@@ -19,7 +19,7 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * This object represents the parsed FunPay preview user

client/src/main/java/com/therepanic/funpay4j/objects/user/ParsedSellerReview.java

@@ -19,7 +19,7 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * This object represents the parsed FunPay seller review

client/src/main/java/com/therepanic/funpay4j/objects/user/ParsedUser.java

@@ -22,7 +22,7 @@
 import lombok.NoArgsConstructor;
 import lombok.experimental.SuperBuilder;
 
-import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.Nullable;
 
 /**
  * This object represents the parsed FunPay user

client/src/main/java/com/therepanic/funpay4j/parser/FunPayParser.java

@@ -16,6 +16,8 @@
 
 import java.util.List;
 
+import org.jspecify.annotations.Nullable;
+
 import com.therepanic.funpay4j.exceptions.FunPayApiException;
 import com.therepanic.funpay4j.exceptions.InvalidGoldenKeyException;
 import com.therepanic.funpay4j.exceptions.lot.LotNotFoundException;
@@ -158,7 +160,7 @@ List<ParsedSellerReview> parseSellerReviews(
      * @throws InvalidGoldenKeyException if the golden key is incorrect
      */
     List<ParsedTransaction> parseTransactions(
-            String goldenKey, long userId, ParsedTransactionType type, int pages)
+            String goldenKey, long userId, @Nullable ParsedTransactionType type, int pages)
             throws FunPayApiException, UserNotFoundException, InvalidGoldenKeyException;
 
     /**

client/src/main/java/com/therepanic/funpay4j/parser/JsoupFunPayParser.java

@@ -23,7 +23,6 @@
 import java.util.Map;
 import java.util.Optional;
 
-import lombok.NonNull;
 import okhttp3.MultipartBody;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
@@ -33,6 +32,7 @@
 import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
 import org.jsoup.nodes.Element;
+import org.jspecify.annotations.Nullable;
 
 import com.google.gson.JsonParser;
 import com.therepanic.funpay4j.FunPayUserUtil;
@@ -67,17 +67,17 @@
  * @since 1.0.0
  */
 public class JsoupFunPayParser implements FunPayParser {
-    @NonNull private final OkHttpClient httpClient;
+    private final OkHttpClient httpClient;
 
-    @NonNull private final String baseURL;
+    private final String baseURL;
 
     /**
      * Creates a new JsoupFunPayParser instance
      *
      * @param httpClient httpClient required to send http requests
      * @param baseURL base URL of the primary server
      */
-    public JsoupFunPayParser(@NonNull OkHttpClient httpClient, @NonNull String baseURL) {
+    public JsoupFunPayParser(OkHttpClient httpClient, String baseURL) {
         this.httpClient = httpClient;
         this.baseURL = baseURL;
     }
@@ -232,7 +232,7 @@ public ParsedLot parseLot(long lotId) throws FunPayApiException, LotNotFoundExce
 
     /** {@inheritDoc} */
     @Override
-    public List<ParsedPromoGame> parsePromoGames(@NonNull String query) throws FunPayApiException {
+    public List<ParsedPromoGame> parsePromoGames(String query) throws FunPayApiException {
         List<ParsedPromoGame> currentPromoGames = new ArrayList<>();
 
         RequestBody requestBody =
@@ -563,7 +563,7 @@ public ParsedOrder parseOrder(String goldenKey, String orderId)
 
     /** {@inheritDoc} */
     @Override
-    public CsrfTokenAndPHPSESSID parseCsrfTokenAndPHPSESSID(@NonNull String goldenKey)
+    public CsrfTokenAndPHPSESSID parseCsrfTokenAndPHPSESSID(String goldenKey)
             throws FunPayApiException {
         // We send a request to /unknown URL that doesn't exist to get a page where it will be
         // reported that the page doesn't exist.
@@ -612,7 +612,7 @@ public CsrfTokenAndPHPSESSID parseCsrfTokenAndPHPSESSID(@NonNull String goldenKe
      * @throws FunPayApiException if the other api-related exception
      * @throws UserNotFoundException if the user with id does not found
      */
-    private ParsedUser parseUserInternal(String goldenKey, long userId)
+    private ParsedUser parseUserInternal(@Nullable String goldenKey, long userId)
             throws FunPayApiException, UserNotFoundException {
         Request.Builder newCallBuilder =
                 new Request.Builder().get().url(baseURL + "/users/" + userId + "/");
@@ -795,7 +795,7 @@ private ParsedUser parseUserInternal(String goldenKey, long userId)
      * @throws InvalidGoldenKeyException if the golden key is incorrect
      */
     private List<ParsedTransaction> parseTransactionsInternal(
-            String goldenKey, long userId, ParsedTransactionType type, int pages)
+            String goldenKey, long userId, @Nullable ParsedTransactionType type, int pages)
             throws FunPayApiException, UserNotFoundException, InvalidGoldenKeyException {
         List<ParsedTransaction> parsedTransactions = new ArrayList<>();
 
@@ -927,7 +927,7 @@ private List<ParsedTransaction> parseTransactionsInternal(
      * @throws UserNotFoundException if the user with id does not found/seller
      */
     private List<ParsedSellerReview> parseSellerReviewsInternal(
-            String goldenKey, long userId, int pages, String starsFilter)
+            @Nullable String goldenKey, long userId, int pages, @Nullable String starsFilter)
             throws FunPayApiException, UserNotFoundException {
         List<ParsedSellerReview> currentSellerReviews = new ArrayList<>();
 

client/src/main/java/com/therepanic/funpay4j/parser/package-info.java

@@ -0,0 +1,16 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+@org.jspecify.annotations.NullMarked
+package com.therepanic.funpay4j.parser;