Annotate much of java.util.zip. (#106)

Prompted by google/xplat@4461165. Co-authored-by: Werner Dietl <[email protected]>
jspecify · Dec 18, 2024 · 9d345e7 · 9d345e7
1 parent f669c5b
commit 9d345e7
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 6 deletions.
diff --git a/src/java.base/share/classes/java/util/zip/Adler32.java b/src/java.base/share/classes/java/util/zip/Adler32.java
@@ -30,6 +30,7 @@
 import jdk.internal.util.Preconditions;
 import jdk.internal.vm.annotation.IntrinsicCandidate;
 import sun.nio.ch.DirectBuffer;
+import org.jspecify.annotations.NullMarked;
 
 import static java.util.zip.ZipUtils.NIO_ACCESS;
 
@@ -44,6 +45,7 @@
  * @author      David Connelly
  * @since 1.1
  */
+@NullMarked
 public class Adler32 implements Checksum {
 
     private int adler = 1;

diff --git a/src/java.base/share/classes/java/util/zip/Checksum.java b/src/java.base/share/classes/java/util/zip/Checksum.java
@@ -25,13 +25,15 @@
 package java.util.zip;
 
 import java.nio.ByteBuffer;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * An interface representing a data checksum.
  *
  * @author David Connelly
  * @since 1.1
  */
+@NullMarked
 public interface Checksum {
 
     /**

diff --git a/src/java.base/share/classes/java/util/zip/DataFormatException.java b/src/java.base/share/classes/java/util/zip/DataFormatException.java
@@ -25,12 +25,16 @@
 
 package java.util.zip;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
 /**
  * Signals that a data format error has occurred.
  *
  * @author      David Connelly
  * @since 1.1
  */
+@NullMarked
 public class DataFormatException extends Exception {
     @java.io.Serial
     private static final long serialVersionUID = 2219632870893641452L;
@@ -47,7 +51,7 @@ public DataFormatException() {
      * A detail message is a String that describes this particular exception.
      * @param s the String containing a detail message
      */
-    public DataFormatException(String s) {
+    public DataFormatException(@Nullable String s) {
         super(s);
     }
 }
diff --git a/src/java.base/share/classes/java/util/zip/Deflater.java b/src/java.base/share/classes/java/util/zip/Deflater.java
@@ -33,6 +33,7 @@
 import jdk.internal.ref.CleanerFactory;
 import jdk.internal.util.Preconditions;
 import sun.nio.ch.DirectBuffer;
+import org.jspecify.annotations.NullMarked;
 
 import static java.util.zip.ZipUtils.NIO_ACCESS;
 
@@ -70,7 +71,7 @@
  * @author      David Connelly
  * @since 1.1
  */
-
+@NullMarked
 public class Deflater {
 
     private final DeflaterZStreamRef zsRef;

diff --git a/src/java.base/share/classes/java/util/zip/DeflaterOutputStream.java b/src/java.base/share/classes/java/util/zip/DeflaterOutputStream.java
@@ -29,6 +29,7 @@
 import java.io.OutputStream;
 import java.io.InputStream;
 import java.io.IOException;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * This class implements an output stream filter for compressing data in
@@ -42,6 +43,7 @@
  * @author      David Connelly
  * @since 1.1
  */
+@NullMarked
 public class DeflaterOutputStream extends FilterOutputStream {
     /**
      * Compressor for this stream.

diff --git a/src/java.base/share/classes/java/util/zip/Inflater.java b/src/java.base/share/classes/java/util/zip/Inflater.java
@@ -33,6 +33,7 @@
 import jdk.internal.ref.CleanerFactory;
 import jdk.internal.util.Preconditions;
 import sun.nio.ch.DirectBuffer;
+import org.jspecify.annotations.NullMarked;
 
 import static java.util.zip.ZipUtils.NIO_ACCESS;
 
@@ -70,7 +71,7 @@
  * @since 1.1
  *
  */
-
+@NullMarked
 public class Inflater {
 
     private final InflaterZStreamRef zsRef;

diff --git a/src/java.base/share/classes/java/util/zip/InflaterOutputStream.java b/src/java.base/share/classes/java/util/zip/InflaterOutputStream.java
@@ -29,6 +29,7 @@
 import java.io.IOException;
 import java.io.OutputStream;
 import java.util.Objects;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * Implements an output stream filter for uncompressing data stored in the
@@ -41,7 +42,7 @@
  * @see DeflaterInputStream
  * @see DeflaterOutputStream
  */
-
+@NullMarked
 public class InflaterOutputStream extends FilterOutputStream {
     /** Decompressor for this stream. */
     protected final Inflater inf;

diff --git a/src/java.base/share/classes/java/util/zip/ZipException.java b/src/java.base/share/classes/java/util/zip/ZipException.java
@@ -26,14 +26,16 @@
 package java.util.zip;
 
 import java.io.IOException;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 /**
  * Signals that a ZIP exception of some sort has occurred.
  *
  * @see     java.io.IOException
  * @since   1.1
  */
-
+@NullMarked
 public class ZipException extends IOException {
     @java.io.Serial
     private static final long serialVersionUID = 8000196834066748623L;
@@ -53,7 +55,7 @@ public ZipException() {
      * @param   s   the detail message.
      */
 
-    public ZipException(String s) {
+    public ZipException(@Nullable String s) {
         super(s);
     }
 }