Merge pull request #687 from ascopes/bugfix/nullability-annotations

Fix nullability annotations, documentation.

Author: ascopes

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/AbstractContainerGroupAssert.java

@@ -25,7 +25,6 @@
 import org.apiguardian.api.API.Status;
 import org.assertj.core.api.AbstractAssert;
 import org.assertj.core.api.AbstractListAssert;
-import org.assertj.core.api.Assertions;
 import org.assertj.core.api.ObjectAssert;
 import org.jspecify.annotations.Nullable;
 
@@ -47,6 +46,7 @@ public abstract class AbstractContainerGroupAssert<I extends AbstractContainerGr
    * @param containerGroup the container group to assert upon.
    * @param selfType       the type of the assertion implementation to use.
    */
+  @SuppressWarnings("DataFlowIssue")
   protected AbstractContainerGroupAssert(@Nullable C containerGroup, Class<?> selfType) {
     super(containerGroup, selfType);
   }

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/AbstractEnumAssert.java

@@ -44,6 +44,7 @@ public abstract class AbstractEnumAssert<A extends AbstractEnumAssert<A, E>, E e
    * @param value    the value to assert upon.
    * @param selfType the type of this assertion implementation.
    */
+  @SuppressWarnings("DataFlowIssue")
   protected AbstractEnumAssert(@Nullable E value, Class<?> selfType) {
     super(value, selfType);
   }

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/AbstractJavaFileObjectAssert.java

@@ -54,6 +54,7 @@ public abstract class AbstractJavaFileObjectAssert<I extends AbstractJavaFileObj
    * @param actual   the actual value to assert on.
    * @param selfType the type of the assertion implementation.
    */
+  @SuppressWarnings("DataFlowIssue")
   protected AbstractJavaFileObjectAssert(@Nullable A actual, Class<?> selfType) {
     super(actual, selfType);
   }
@@ -167,10 +168,10 @@ public JavaFileObjectKindAssert kind() {
 
   private byte[] rawContent() {
     return uncheckedIo(() -> {
-      var baos = new ByteArrayOutputStream();
-      try (var is = actual.openInputStream()) {
-        is.transferTo(baos);
-        return baos.toByteArray();
+      var outputStream = new ByteArrayOutputStream();
+      try (var inputStream = actual.openInputStream()) {
+        inputStream.transferTo(outputStream);
+        return outputStream.toByteArray();
       }
     });
   }

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/ClassLoaderAssert.java

@@ -37,6 +37,7 @@ public final class ClassLoaderAssert extends AbstractAssert<ClassLoaderAssert, C
    *
    * @param actual the class loader to assert upon.
    */
+  @SuppressWarnings("DataFlowIssue")
   public ClassLoaderAssert(@Nullable ClassLoader actual) {
     super(actual, ClassLoaderAssert.class);
   }

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/JctAssertions.java

@@ -37,6 +37,7 @@
  * @since 0.0.1
  */
 @API(since = "0.0.1", status = Status.STABLE)
+@SuppressWarnings("unused")
 public final class JctAssertions extends UtilityClass {
 
   private JctAssertions() {
@@ -256,7 +257,7 @@ public static TraceDiagnosticAssert assertThatDiagnostic(
    * @return the assertion.
    */
   public static TraceDiagnosticListAssert assertThatDiagnostics(
-      @Nullable List<@Nullable ? extends TraceDiagnostic<? extends JavaFileObject>> diagnostics
+      @Nullable List<? extends TraceDiagnostic<? extends JavaFileObject>> diagnostics
   ) {
     return new TraceDiagnosticListAssert(diagnostics);
   }

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/JctCompilationAssert.java

@@ -51,6 +51,7 @@ public final class JctCompilationAssert extends
    *
    * @param value the value to assert on.
    */
+  @SuppressWarnings("DataFlowIssue")
   public JctCompilationAssert(@Nullable JctCompilation value) {
     super(value, JctCompilationAssert.class);
   }

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/LocationAssert.java

@@ -39,6 +39,7 @@ public final class LocationAssert extends AbstractAssert<LocationAssert, Locatio
    *
    * @param value the value to assert on.
    */
+  @SuppressWarnings("DataFlowIssue")
   public LocationAssert(@Nullable Location value) {
     super(value, LocationAssert.class);
     info.useRepresentation(LocationRepresentation.getInstance());

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/PackageContainerGroupAssert.java

@@ -102,17 +102,17 @@ public PackageContainerGroupAssert allFilesExist(Iterable<String> paths) {
       }
     }
 
-    if (errors.size() >= 1) {
-      throw new MultipleAssertionsError(
-          new TextDescription(
-              "Expected all paths in %s to exist but one or more did not",
-              quotedIterable(paths)
-          ),
-          errors
-      );
+    if (errors.isEmpty()) {
+      return this;
     }
 
-    return this;
+    throw new MultipleAssertionsError(
+        new TextDescription(
+            "Expected all paths in %s to exist but one or more did not",
+            quotedIterable(paths)
+        ),
+        errors
+    );
   }
 
   /**
@@ -207,6 +207,7 @@ public AbstractPathAssert<?> fileExists(String fragment, String... fragments) {
         this::quotedUserProvidedPath,
         "file with relative path"
     );
+
     throw failure(message);
   }
 
@@ -247,7 +248,7 @@ private <T> String fuzzySafePath(Iterable<T> parts) {
   }
 
   private boolean fileNameIsPresent(@Nullable Path path) {
-    // Path can be null if no path elements exist in ZipPath impls.
+    // Path can be null if no path elements exist in ZipPath implementations.
     return Optional
         .ofNullable(path)
         .map(Path::getFileName)

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/StackTraceAssert.java

@@ -41,6 +41,7 @@ public final class StackTraceAssert
    *
    * @param actual the list of stack trace elements to assert upon.
    */
+  @SuppressWarnings("DataFlowIssue")
   public StackTraceAssert(@Nullable List<? extends StackTraceElement> actual) {
     super(actual, StackTraceAssert.class);
     info.useRepresentation(StackTraceRepresentation.getInstance());

java-compiler-testing/src/main/java/io/github/ascopes/jct/assertions/StackTraceElementAssert.java

@@ -43,6 +43,7 @@ public final class StackTraceElementAssert
    *
    * @param actual the stacktrace element to assert upon.
    */
+  @SuppressWarnings("DataFlowIssue")
   public StackTraceElementAssert(@Nullable StackTraceElement actual) {
     super(actual, StackTraceElementAssert.class);
   }