Improve nullability and java docs

Author: markushi

sentry-android-core/api/sentry-android-core.api

@@ -151,14 +151,13 @@ public final class io/sentry/android/core/CurrentActivityIntegration : android/a
 	public fun register (Lio/sentry/IHub;Lio/sentry/SentryOptions;)V
 }
 
-public class io/sentry/android/core/DeviceInfoUtil {
+public final class io/sentry/android/core/DeviceInfoUtil {
 	public fun <init> (Landroid/content/Context;Lio/sentry/android/core/SentryAndroidOptions;)V
 	public fun collectDeviceInformation (ZZ)Lio/sentry/protocol/Device;
 	public static fun getInstance (Landroid/content/Context;Lio/sentry/android/core/SentryAndroidOptions;)Lio/sentry/android/core/DeviceInfoUtil;
-	public final fun getOperatingSystem ()Lio/sentry/protocol/OperatingSystem;
+	public fun getOperatingSystem ()Lio/sentry/protocol/OperatingSystem;
 	public fun getSideLoadedInfo ()Lio/sentry/android/core/ContextUtils$SideLoadedInfo;
 	public static fun resetInstance ()V
-	protected fun retrieveOperatingSystemInformation ()Lio/sentry/protocol/OperatingSystem;
 }
 
 public abstract class io/sentry/android/core/EnvelopeFileObserverIntegration : io/sentry/Integration, java/io/Closeable {
@@ -173,10 +172,6 @@ public abstract interface class io/sentry/android/core/IDebugImagesLoader {
 	public abstract fun loadDebugImages ()Ljava/util/List;
 }
 
-public final class io/sentry/android/core/Installation {
-	public static fun id (Landroid/content/Context;)Ljava/lang/String;
-}
-
 public final class io/sentry/android/core/InternalSentrySdk {
 	public fun <init> ()V
 	public static fun captureEnvelope ([B)Lio/sentry/protocol/SentryId;

sentry-android-core/src/main/java/io/sentry/android/core/DeviceInfoUtil.java

@@ -35,7 +35,7 @@
 import org.jetbrains.annotations.TestOnly;
 
 @ApiStatus.Internal
-public class DeviceInfoUtil {
+public final class DeviceInfoUtil {
 
   @SuppressLint("StaticFieldLeak")
   private static volatile DeviceInfoUtil instance;
@@ -61,7 +61,8 @@ public DeviceInfoUtil(
         ContextUtils.retrieveSideLoadedInfo(context, options.getLogger(), buildInfoProvider);
   }
 
-  public static @NotNull DeviceInfoUtil getInstance(
+  @NotNull
+  public static DeviceInfoUtil getInstance(
       final @NotNull Context context, final @NotNull SentryAndroidOptions options) {
     if (instance == null) {
       synchronized (DeviceInfoUtil.class) {
@@ -139,7 +140,8 @@ public Device collectDeviceInformation(
     return device;
   }
 
-  public final @NotNull OperatingSystem getOperatingSystem() {
+  @NotNull
+  public OperatingSystem getOperatingSystem() {
     return os;
   }
 
@@ -164,7 +166,8 @@ protected OperatingSystem retrieveOperatingSystemInformation() {
     return os;
   }
 
-  public @Nullable ContextUtils.SideLoadedInfo getSideLoadedInfo() {
+  @Nullable
+  public ContextUtils.SideLoadedInfo getSideLoadedInfo() {
     return sideLoadedInfo;
   }
 
@@ -226,6 +229,7 @@ private void setDeviceIO(final @NotNull Device device, final boolean includeDyna
   }
 
   @SuppressWarnings("NewApi")
+  @NotNull
   private TimeZone getTimeZone() {
     if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.N) {
       LocaleList locales = context.getResources().getConfiguration().getLocales();
@@ -238,7 +242,8 @@ private TimeZone getTimeZone() {
   }
 
   @SuppressWarnings("JdkObsolete")
-  private @Nullable Date getBootTime() {
+  @Nullable
+  private Date getBootTime() {
     try {
       // if user changes the clock, will give a wrong answer, consider ACTION_TIME_CHANGED.
       // currentTimeMillis returns UTC already
@@ -249,7 +254,8 @@ private TimeZone getTimeZone() {
     return null;
   }
 
-  private @Nullable Intent getBatteryIntent() {
+  @Nullable
+  private Intent getBatteryIntent() {
     return context.registerReceiver(null, new IntentFilter(Intent.ACTION_BATTERY_CHANGED));
   }
 
@@ -258,7 +264,8 @@ private TimeZone getTimeZone() {
    *
    * @return the device's current battery level (as a percentage of total), or null if unknown
    */
-  private @Nullable Float getBatteryLevel(final @NotNull Intent batteryIntent) {
+  @Nullable
+  private Float getBatteryLevel(final @NotNull Intent batteryIntent) {
     try {
       int level = batteryIntent.getIntExtra(BatteryManager.EXTRA_LEVEL, -1);
       int scale = batteryIntent.getIntExtra(BatteryManager.EXTRA_SCALE, -1);
@@ -281,7 +288,8 @@ private TimeZone getTimeZone() {
    *
    * @return whether or not the device is currently plugged in and charging, or null if unknown
    */
-  private @Nullable Boolean isCharging(final @NotNull Intent batteryIntent) {
+  @Nullable
+  private Boolean isCharging(final @NotNull Intent batteryIntent) {
     try {
       int plugged = batteryIntent.getIntExtra(BatteryManager.EXTRA_PLUGGED, -1);
       return plugged == BatteryManager.BATTERY_PLUGGED_AC
@@ -292,7 +300,8 @@ private TimeZone getTimeZone() {
     }
   }
 
-  private @Nullable Float getBatteryTemperature(final @NotNull Intent batteryIntent) {
+  @Nullable
+  private Float getBatteryTemperature(final @NotNull Intent batteryIntent) {
     try {
       int temperature = batteryIntent.getIntExtra(EXTRA_TEMPERATURE, -1);
       if (temperature != -1) {
@@ -309,7 +318,8 @@ private TimeZone getTimeZone() {
    *
    * @return the device's current screen orientation, or null if unknown
    */
-  private @Nullable Device.DeviceOrientation getOrientation() {
+  @Nullable
+  private Device.DeviceOrientation getOrientation() {
     Device.DeviceOrientation deviceOrientation = null;
     try {
       deviceOrientation =
@@ -329,7 +339,8 @@ private TimeZone getTimeZone() {
   }
 
   @SuppressWarnings({"ObsoleteSdkInt", "NewApi"})
-  private @NotNull Long getMemorySize(final @NotNull ActivityManager.MemoryInfo memInfo) {
+  @NotNull
+  private Long getMemorySize(final @NotNull ActivityManager.MemoryInfo memInfo) {
     if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.JELLY_BEAN) {
       return memInfo.totalMem;
     }
@@ -342,7 +353,8 @@ private TimeZone getTimeZone() {
    *
    * @return the total amount of internal storage, in bytes
    */
-  private @Nullable Long getTotalInternalStorage(final @NotNull StatFs stat) {
+  @Nullable
+  private Long getTotalInternalStorage(final @NotNull StatFs stat) {
     try {
       long blockSize = getBlockSizeLong(stat);
       long totalBlocks = getBlockCountLong(stat);
@@ -397,7 +409,8 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
    *
    * @return the unused amount of internal storage, in bytes
    */
-  private @Nullable Long getUnusedInternalStorage(final @NotNull StatFs stat) {
+  @Nullable
+  private Long getUnusedInternalStorage(final @NotNull StatFs stat) {
     try {
       long blockSize = getBlockSizeLong(stat);
       long availableBlocks = getAvailableBlocksLong(stat);
@@ -410,7 +423,8 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
     }
   }
 
-  private @Nullable StatFs getExternalStorageStat(final @Nullable File internalStorage) {
+  @Nullable
+  private StatFs getExternalStorageStat(final @Nullable File internalStorage) {
     if (!isExternalStorageMounted()) {
       File path = getExternalStorageDep(internalStorage);
       if (path != null) { // && path.canRead()) { canRead() will read return false
@@ -424,7 +438,8 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
   }
 
   @SuppressWarnings({"ObsoleteSdkInt", "NewApi"})
-  private @Nullable File[] getExternalFilesDirs() {
+  @Nullable
+  private File[] getExternalFilesDirs() {
     if (buildInfoProvider.getSdkInfoVersion() >= Build.VERSION_CODES.KITKAT) {
       return context.getExternalFilesDirs(null);
     } else {
@@ -436,7 +451,8 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
     return null;
   }
 
-  private @Nullable File getExternalStorageDep(final @Nullable File internalStorage) {
+  @Nullable
+  private File getExternalStorageDep(final @Nullable File internalStorage) {
     final @Nullable File[] externalFilesDirs = getExternalFilesDirs();
 
     if (externalFilesDirs != null) {
@@ -471,7 +487,8 @@ private int getAvailableBlocksDep(final @NotNull StatFs stat) {
    * @return the total amount of external storage, in bytes, or null if no external storage is
    *     mounted
    */
-  private @Nullable Long getTotalExternalStorage(final @NotNull StatFs stat) {
+  @Nullable
+  private Long getTotalExternalStorage(final @NotNull StatFs stat) {
     try {
       final long blockSize = getBlockSizeLong(stat);
       final long totalBlocks = getBlockCountLong(stat);
@@ -495,7 +512,8 @@ private boolean isExternalStorageMounted() {
    * @return the unused amount of external storage, in bytes, or null if no external storage is
    *     mounted
    */
-  private @Nullable Long getUnusedExternalStorage(final @NotNull StatFs stat) {
+  @Nullable
+  private Long getUnusedExternalStorage(final @NotNull StatFs stat) {
     try {
       final long blockSize = getBlockSizeLong(stat);
       final long availableBlocks = getAvailableBlocksLong(stat);
@@ -508,7 +526,8 @@ private boolean isExternalStorageMounted() {
     }
   }
 
-  private @Nullable String getDeviceId() {
+  @Nullable
+  private String getDeviceId() {
     try {
       return Installation.id(context);
     } catch (Throwable e) {

sentry-android-core/src/main/java/io/sentry/android/core/Installation.java

@@ -8,13 +8,11 @@
 import java.io.RandomAccessFile;
 import java.nio.charset.Charset;
 import java.util.UUID;
-import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.TestOnly;
 
-@ApiStatus.Internal
-public final class Installation {
+final class Installation {
   @TestOnly static @Nullable String deviceId = null;
 
   @TestOnly static final String INSTALLATION = "INSTALLATION";

sentry-android-core/src/main/java/io/sentry/android/core/InternalSentrySdk.java

@@ -45,9 +45,21 @@ public static Scope getCurrentScope() {
     return scopeRef.get();
   }
 
+  /**
+   * Serializes the provided scope. Specific data may be back-filled (e.g. device context) if the
+   * scope itself does not provide it.
+   *
+   * @param context Android context
+   * @param options Sentry Options
+   * @param scope the scope
+   * @return a map containing all relevant scope data (user, contexts, tags, extras, fingerprint,
+   *     level, breadcrumbs)
+   */
   @NotNull
   public static Map<String, Object> serializeScope(
-      @NotNull Context context, @NotNull SentryAndroidOptions options, @Nullable Scope scope) {
+      final @NotNull Context context,
+      final @NotNull SentryAndroidOptions options,
+      final @Nullable Scope scope) {
     final @NotNull Map<String, Object> data = new HashMap<>();
     if (scope == null) {
       return data;
@@ -70,7 +82,11 @@ public static Map<String, Object> serializeScope(
         scope.setUser(user);
       }
       if (user.getId() == null) {
-        user.setId(Installation.id(context));
+        try {
+          user.setId(Installation.id(context));
+        } catch (RuntimeException e) {
+          logger.log(SentryLevel.ERROR, "Could not retrieve installation ID", e);
+        }
       }
 
       // app context
@@ -160,8 +176,8 @@ public static SentryId captureEnvelope(final @NotNull byte[] envelopeData) throw
 
   @Nullable
   private static Session updateSession(
-      @NotNull IHub hub,
-      @NotNull SentryOptions options,
+      final @NotNull IHub hub,
+      final @NotNull SentryOptions options,
       final @Nullable Session.State status,
       final boolean crashedOrErrored) {
     final @NotNull AtomicReference<Session> sessionRef = new AtomicReference<>();

sentry/src/main/java/io/sentry/Breadcrumb.java

@@ -561,7 +561,8 @@ public static final class JsonKeys {
   }
 
   @Override
-  public void serialize(@NotNull ObjectWriter writer, @NotNull ILogger logger) throws IOException {
+  public void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger logger)
+      throws IOException {
     writer.beginObject();
     writer.name(JsonKeys.TIMESTAMP).value(logger, timestamp);
     if (message != null) {

sentry/src/main/java/io/sentry/JsonObjectWriter.java

@@ -8,10 +8,10 @@
 
 public final class JsonObjectWriter implements ObjectWriter {
 
-  private final JsonWriter jsonWriter;
-  private final JsonObjectSerializer jsonObjectSerializer;
+  private final @NotNull JsonWriter jsonWriter;
+  private final @NotNull JsonObjectSerializer jsonObjectSerializer;
 
-  public JsonObjectWriter(Writer out, int maxDepth) {
+  public JsonObjectWriter(final @NotNull Writer out, final int maxDepth) {
     jsonWriter = new JsonWriter(out);
     jsonObjectSerializer = new JsonObjectSerializer(maxDepth);
   }
@@ -41,13 +41,13 @@ public JsonObjectWriter endObject() throws IOException {
   }
 
   @Override
-  public JsonObjectWriter name(String name) throws IOException {
+  public JsonObjectWriter name(final @NotNull String name) throws IOException {
     jsonWriter.name(name);
     return this;
   }
 
   @Override
-  public JsonObjectWriter value(String value) throws IOException {
+  public JsonObjectWriter value(final @Nullable String value) throws IOException {
     jsonWriter.value(value);
     return this;
   }
@@ -59,31 +59,31 @@ public JsonObjectWriter nullValue() throws IOException {
   }
 
   @Override
-  public JsonObjectWriter value(boolean value) throws IOException {
+  public JsonObjectWriter value(final boolean value) throws IOException {
     jsonWriter.value(value);
     return this;
   }
 
   @Override
-  public JsonObjectWriter value(Boolean value) throws IOException {
+  public JsonObjectWriter value(final @Nullable Boolean value) throws IOException {
     jsonWriter.value(value);
     return this;
   }
 
   @Override
-  public JsonObjectWriter value(double value) throws IOException {
+  public JsonObjectWriter value(final double value) throws IOException {
     jsonWriter.value(value);
     return this;
   }
 
   @Override
-  public JsonObjectWriter value(long value) throws IOException {
+  public JsonObjectWriter value(final long value) throws IOException {
     jsonWriter.value(value);
     return this;
   }
 
   @Override
-  public JsonObjectWriter value(Number value) throws IOException {
+  public JsonObjectWriter value(final @Nullable Number value) throws IOException {
     jsonWriter.value(value);
     return this;
   }
@@ -97,13 +97,13 @@ public JsonObjectWriter value(Number value) throws IOException {
    * @return this writer.
    */
   @Override
-  public JsonObjectWriter value(@NotNull ILogger logger, @Nullable Object object)
+  public JsonObjectWriter value(final @NotNull ILogger logger, final @Nullable Object object)
       throws IOException {
     jsonObjectSerializer.serialize(this, logger, object);
     return this;
   }
 
-  public void setIndent(@NotNull final String indent) {
+  public void setIndent(final @NotNull String indent) {
     jsonWriter.setIndent(indent);
   }
 }

sentry/src/main/java/io/sentry/JsonSerializable.java

@@ -4,5 +4,6 @@
 import org.jetbrains.annotations.NotNull;
 
 public interface JsonSerializable {
-  void serialize(@NotNull ObjectWriter writer, @NotNull ILogger logger) throws IOException;
+  void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger logger)
+      throws IOException;
 }