comments & annotations updated.

syslogic · Oct 16, 2024 · 8deb99b · 8deb99b
1 parent 8af80c3
commit 8deb99b
Show file tree

Hide file tree

Showing 46 changed files with 73 additions and 102 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,7 +1,7 @@
 [versions]
 android_gradle = '8.7.1'
 gradle_publish = '1.2.2'
-plugin_version = '1.3.5'
+plugin_version = '1.3.6'
 annotations    = '23.0.0'
 httpcore       = '4.4.16'
 httpclient     = '4.5.14'

diff --git a/src/main/java/io/syslogic/agconnect/PublishingExtension.java b/src/main/java/io/syslogic/agconnect/PublishingExtension.java
@@ -46,6 +46,7 @@ public interface PublishingExtension {
      * <code>agcPublishing { releaseType = 1 }</code>
      * @param value 1=network, 3=phased.
      */
+    @SuppressWarnings({"unused"})
      void setReleaseType(Integer value);
 
     /**

diff --git a/src/main/java/io/syslogic/agconnect/PublishingPlugin.java b/src/main/java/io/syslogic/agconnect/PublishingPlugin.java
@@ -34,11 +34,11 @@
 @SuppressWarnings("unused")
 class PublishingPlugin implements Plugin<Project> {
 
-    private @NotNull final String taskGroup = "agconnect";
-    private @Nullable PublishingExtension extension;
-    private @Nullable String configFile = null;
-    private @NotNull Boolean logHttp = false;
-    private @NotNull Boolean verbose = false;
+    @NotNull private final String taskGroup = "agconnect";
+    @Nullable private PublishingExtension extension;
+    @Nullable private String configFile = null;
+    @NotNull private Boolean logHttp = false;
+    @NotNull private Boolean verbose = false;
 
     /** It depends on :assembleRelease or :bundleRelease */
     @Override

diff --git a/src/main/java/io/syslogic/agconnect/constants/ArtifactType.java b/src/main/java/io/syslogic/agconnect/constants/ArtifactType.java
@@ -2,7 +2,6 @@
 
 /**
  * Artifact Types
- *
  * @author Martin Zeitler
  */
 public class ArtifactType {

diff --git a/src/main/java/io/syslogic/agconnect/constants/ConsoleUrl.java b/src/main/java/io/syslogic/agconnect/constants/ConsoleUrl.java
@@ -2,7 +2,6 @@
 
 /**
  * AppGallery Connect Console URL
- *
  * @author Martin Zeitler
  */
 public class ConsoleUrl {

diff --git a/src/main/java/io/syslogic/agconnect/constants/EndpointUrl.java b/src/main/java/io/syslogic/agconnect/constants/EndpointUrl.java
@@ -2,7 +2,6 @@
 
 /**
  * AppGallery Connect API Endpoints
- *
  * @author Martin Zeitler
  */
 public class EndpointUrl {

diff --git a/src/main/java/io/syslogic/agconnect/model/ApiConfigFile.java b/src/main/java/io/syslogic/agconnect/model/ApiConfigFile.java
@@ -3,9 +3,8 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: ApiConfig
+ * Data Model: ApiConfig
  * This is file distribution/agc-apiclient.json.
- *
  * @author Martin Zeitler
  */
 public class ApiConfigFile {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppConfigFile.java b/src/main/java/io/syslogic/agconnect/model/AppConfigFile.java
@@ -5,9 +5,8 @@
 import java.util.ArrayList;
 
 /**
- * Abstract Model: AppConfig
+ * Data Model: AppConfig
  * This is file agconnect-services.json, where only appInfo.appId is of interest.
- *
  * @author Martin Zeitler
  */
 public class AppConfigFile {
@@ -19,6 +18,7 @@ public class AppConfigFile {
     private ArrayList<AppConfigInfo> appInfos;
 
     /** @return the configVersion. */
+    @SuppressWarnings({"unused"})
     public String getConfigVersion() {
         return this.configVersion;
     }

diff --git a/src/main/java/io/syslogic/agconnect/model/AppConfigInfo.java b/src/main/java/io/syslogic/agconnect/model/AppConfigInfo.java
@@ -3,9 +3,8 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AppConfigInfo
+ * Data Model: AppConfigInfo
  * This is file agconnect-services.json, where only appId is of interest.
- *
  * @author Martin Zeitler
  */
 public class AppConfigInfo {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppIdListResponse.java b/src/main/java/io/syslogic/agconnect/model/AppIdListResponse.java
@@ -5,8 +5,7 @@
 import java.util.List;
 
 /**
- * Abstract Model: AppIdListResponse
- *
+ * Data Model: AppIdListResponse
  * @author Martin Zeitler
  */
 public class AppIdListResponse {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfo.java b/src/main/java/io/syslogic/agconnect/model/AppInfo.java
@@ -7,8 +7,7 @@
 import java.util.List;
 
 /**
- * Abstract Model: AppInfo
- *
+ * Data Model: AppInfo
  * @author Martin Zeitler
  */
 public class AppInfo {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfoAppId.java b/src/main/java/io/syslogic/agconnect/model/AppInfoAppId.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AppInfoAppId
- *
+ * Data Model: AppInfoAppId
  * @author Martin Zeitler
  */
 public class AppInfoAppId {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfoDeviceMaterial.java b/src/main/java/io/syslogic/agconnect/model/AppInfoDeviceMaterial.java
@@ -1,8 +1,7 @@
 package io.syslogic.agconnect.model;
 
 /**
- * Abstract Model: AppInfoDeviceMaterial
- *
+ * Data Model: AppInfoDeviceMaterial
  * @author Martin Zeitler
  */
 public class AppInfoDeviceMaterial {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfoDeviceType.java b/src/main/java/io/syslogic/agconnect/model/AppInfoDeviceType.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AppInfoDeviceType
- *
+ * Data Model: AppInfoDeviceType
  * @author Martin Zeitler
  */
 public class AppInfoDeviceType {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfoLanguage.java b/src/main/java/io/syslogic/agconnect/model/AppInfoLanguage.java
@@ -5,8 +5,7 @@
 import java.util.List;
 
 /**
- * Abstract Model: AppInfoLanguage
- *
+ * Data Model: AppInfoLanguage
  * @author Martin Zeitler
  */
 public class AppInfoLanguage {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfoLocalization.java b/src/main/java/io/syslogic/agconnect/model/AppInfoLocalization.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AppInfoLocalization
- *
+ * Data Model: AppInfoLocalization
  * @author Martin Zeitler
  */
 public class AppInfoLocalization {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfoResponse.java b/src/main/java/io/syslogic/agconnect/model/AppInfoResponse.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AppInfoResponse
- *
+ * Data Model: AppInfoResponse
  * @author Martin Zeitler
  */
 public class AppInfoResponse {
@@ -16,6 +15,7 @@ public class AppInfoResponse {
     private AppInfo appInfo;
 
     /** @return response status. */
+    @SuppressWarnings({"unused"})
     public ResponseStatus getRet() {
         return this.ret;
     }

diff --git a/src/main/java/io/syslogic/agconnect/model/AppInfoSimple.java b/src/main/java/io/syslogic/agconnect/model/AppInfoSimple.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AppInfo Simple
- *
+ * Data Model: AppInfo Simple
  * @author Martin Zeitler
  */
 public class AppInfoSimple {

diff --git a/src/main/java/io/syslogic/agconnect/model/AppSubmitResponse.java b/src/main/java/io/syslogic/agconnect/model/AppSubmitResponse.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AppSubmitResponse
- *
+ * Data Model: AppSubmitResponse
  * @author Martin Zeitler
  */
 public class AppSubmitResponse {

diff --git a/src/main/java/io/syslogic/agconnect/model/AuditInfo.java b/src/main/java/io/syslogic/agconnect/model/AuditInfo.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: AuditInfo
- *
+ * Data Model: AuditInfo
  * @author Martin Zeitler
  */
 public class AuditInfo {
@@ -59,36 +58,43 @@ public class AuditInfo {
     private String recordAuditOpinion;
 
     /** @return audit opinion. */
+    @SuppressWarnings({"unused"})
     public String getAuditOpinion() {
         return this.auditOpinion;
     }
 
     /** @return copyright audit result. */
+    @SuppressWarnings({"unused"})
     public Integer getCopyRightAuditResult() {
         return this.copyRightAuditResult;
     }
 
     /** @return copyright audit opinion. */
+    @SuppressWarnings({"unused"})
     public String getCopyRightAuditOpinion() {
         return this.copyRightAuditOpinion;
     }
 
     /** @return copyright code-audit result. */
+    @SuppressWarnings({"unused"})
     public Integer getCopyRightCodeAuditResult() {
         return this.copyRightCodeAuditResult;
     }
 
     /** @return copyright code-audit opinion. */
+    @SuppressWarnings({"unused"})
     public String getCopyRightCodeAuditOpinion() {
         return this.copyRightCodeAuditOpinion;
     }
 
     /** @return record audit result. */
+    @SuppressWarnings({"unused"})
     public Integer getRecordAuditResult() {
         return this.recordAuditResult;
     }
 
     /** @return record audit opinion. */
+    @SuppressWarnings({"unused"})
     public String getRecordAuditOpinion() {
         return this.recordAuditOpinion;
     }

diff --git a/src/main/java/io/syslogic/agconnect/model/CompilePackageState.java b/src/main/java/io/syslogic/agconnect/model/CompilePackageState.java
@@ -3,7 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: CompilePackageState
+ * Data Model: CompilePackageState
  * Note: `aabCompileStatus` and `failReason` will be deprecated.
  * @author Martin Zeitler
  */
@@ -26,7 +26,6 @@ public String getPackageId() {
 
     /**
      * App package status
-     *
      * 0: normal
      * 1: being parsed or failed (indicating that the app package is unavailable)
      * @return either 0 or 1.

diff --git a/src/main/java/io/syslogic/agconnect/model/CompileStateResponse.java b/src/main/java/io/syslogic/agconnect/model/CompileStateResponse.java
@@ -5,8 +5,7 @@
 import java.util.List;
 
 /**
- * Abstract Model: CompileStatusResponse
- *
+ * Data Model: CompileStatusResponse
  * @author Martin Zeitler
  */
 public class CompileStateResponse {

diff --git a/src/main/java/io/syslogic/agconnect/model/FileInfoUpdateRequest.java b/src/main/java/io/syslogic/agconnect/model/FileInfoUpdateRequest.java
@@ -4,22 +4,23 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: FileInfoUpdateRequest
- *
+ * Data Model: FileInfoUpdateRequest
  * @author Martin Zeitler
  */
 @SuppressWarnings({"FieldMayBeFinal"})
 public class FileInfoUpdateRequest {
 
     @SerializedName("lang")
+    @SuppressWarnings({"FieldCanBeLocal", "unused"})
     private String lang = "en-US";
 
     @SerializedName("fileType")
+    @SuppressWarnings({"FieldCanBeLocal", "unused"})
     private int fileType = 5;
 
     // only one item!
-    @SuppressWarnings("FieldCanBeLocal")
     @SerializedName("files")
+    @SuppressWarnings({"FieldCanBeLocal", "unused"})
     private FileUploadInfo fileInfo;
 
     /**

diff --git a/src/main/java/io/syslogic/agconnect/model/FileInfoUpdateResponse.java b/src/main/java/io/syslogic/agconnect/model/FileInfoUpdateResponse.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: FileInfoUpdateResponse
- *
+ * Data Model: FileInfoUpdateResponse
  * @author Martin Zeitler
  */
 public class FileInfoUpdateResponse {

diff --git a/src/main/java/io/syslogic/agconnect/model/FileUploadInfo.java b/src/main/java/io/syslogic/agconnect/model/FileUploadInfo.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: FileUploadInfo
- *
+ * Data Model: FileUploadInfo
  * @author Martin Zeitler
  */
 @SuppressWarnings({"FieldMayBeFinal"})

diff --git a/src/main/java/io/syslogic/agconnect/model/PhasedReleaseInfo.java b/src/main/java/io/syslogic/agconnect/model/PhasedReleaseInfo.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: PhasedReleaseInfo
- *
+ * Data Model: PhasedReleaseInfo
  * @author Martin Zeitler
  */
 public class PhasedReleaseInfo {

diff --git a/src/main/java/io/syslogic/agconnect/model/ResponseStatus.java b/src/main/java/io/syslogic/agconnect/model/ResponseStatus.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: ResponseStatus
- *
+ * Data Model: ResponseStatus
  * @author Martin Zeitler
  */
 public class ResponseStatus {

diff --git a/src/main/java/io/syslogic/agconnect/model/TokenRequest.java b/src/main/java/io/syslogic/agconnect/model/TokenRequest.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: TokenRequest
- *
+ * Data Model: TokenRequest
  * @author Martin Zeitler
  */
 @SuppressWarnings({"FieldMayBeFinal"})
@@ -14,9 +13,11 @@ public class TokenRequest {
     private String grantType = "client_credentials";
 
     @SerializedName("client_id")
+    @SuppressWarnings({"FieldCanBeLocal", "unused"})
     private String clientId;
-
+    
     @SerializedName("client_secret")
+    @SuppressWarnings({"FieldCanBeLocal", "unused"})
     private String clientSecret;
 
     /**

diff --git a/src/main/java/io/syslogic/agconnect/model/TokenResponse.java b/src/main/java/io/syslogic/agconnect/model/TokenResponse.java
@@ -3,8 +3,7 @@
 import com.google.gson.annotations.SerializedName;
 
 /**
- * Abstract Model: TokenResponse
- *
+ * Data Model: TokenResponse
  * @author Martin Zeitler
  */
 public class TokenResponse {

diff --git a/src/main/java/io/syslogic/agconnect/model/UploadChunkedRequest.java b/src/main/java/io/syslogic/agconnect/model/UploadChunkedRequest.java
@@ -1,8 +1,7 @@
 package io.syslogic.agconnect.model;
 
 /**
- * Abstract Model: UploadChunkedRequest
- *
+ * TODO: Data Model: UploadChunkedRequest
  * @author Martin Zeitler
  */
 public class UploadChunkedRequest {
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,6 @@ @@
     /**
      * Artifact Types
-     *
      * @author Martin Zeitler
      */
     public class ArtifactType {
@@ Expand Down @@