Add missing CheckReturnValue annotations to assertions package

Author: ascopes

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

@@ -21,6 +21,7 @@
 import io.github.ascopes.jct.containers.ContainerGroup;
 import java.util.ArrayList;
 import java.util.List;
+import javax.annotation.CheckReturnValue;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.NotThreadSafe;
 import org.apiguardian.api.API;
@@ -67,6 +68,7 @@ protected AbstractContainerGroupAssert(@Nullable C containerGroup, Class<?> self
    * @return the assertions to perform.
    * @throws AssertionError if the object being asserted upon is null.
    */
+  @CheckReturnValue
   public LocationAssert location() {
     isNotNull();
     return new LocationAssert(actual.getLocation());
@@ -81,6 +83,7 @@ public LocationAssert location() {
    * @throws AssertionError       if the object being asserted upon is null.
    * @throws NullPointerException if the provided class parameter is null.
    */
+  @CheckReturnValue
   public <T> AbstractListAssert<?, List<? extends T>, T, ? extends ObjectAssert<T>> services(
       Class<T> clazz
   ) {

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

@@ -26,6 +26,7 @@
 import java.nio.charset.CharsetDecoder;
 import java.nio.charset.StandardCharsets;
 import java.time.Instant;
+import javax.annotation.CheckReturnValue;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.NotThreadSafe;
 import javax.tools.JavaFileObject;
@@ -66,6 +67,7 @@ protected AbstractJavaFileObjectAssert(@Nullable A actual, Class<?> selfType) {
    * @return the URI assertion.
    * @throws AssertionError if the actual value is null.
    */
+  @CheckReturnValue
   public AbstractUriAssert<?> uri() {
     isNotNull();
     return assertThat(actual.toUri());
@@ -77,6 +79,7 @@ public AbstractUriAssert<?> uri() {
    * @return the string assertion.
    * @throws AssertionError if the actual value is null.
    */
+  @CheckReturnValue
   public AbstractStringAssert<?> name() {
     isNotNull();
     return assertThat(actual.getName());
@@ -88,6 +91,7 @@ public AbstractStringAssert<?> name() {
    * @return the byte array assertion.
    * @throws AssertionError if the actual value is null.
    */
+  @CheckReturnValue
   public AbstractByteArrayAssert<?> binaryContent() {
     isNotNull();
     return assertThat(rawContent());
@@ -101,6 +105,7 @@ public AbstractByteArrayAssert<?> binaryContent() {
    * @throws AssertionError       if the actual value is null.
    * @throws UncheckedIOException if an IO error occurs reading the file content.
    */
+  @CheckReturnValue
   public AbstractStringAssert<?> content() {
     return content(StandardCharsets.UTF_8);
   }
@@ -114,6 +119,7 @@ public AbstractStringAssert<?> content() {
    * @throws NullPointerException if the charset parameter is null.
    * @throws UncheckedIOException if an IO error occurs reading the file content.
    */
+  @CheckReturnValue
   public AbstractStringAssert<?> content(Charset charset) {
     requireNonNull(charset, "charset must not be null");
     return content(charset.newDecoder());
@@ -128,6 +134,7 @@ public AbstractStringAssert<?> content(Charset charset) {
    * @throws NullPointerException if the charset decoder parameter is null.
    * @throws UncheckedIOException if an IO error occurs reading the file content.
    */
+  @CheckReturnValue
   public AbstractStringAssert<?> content(CharsetDecoder charsetDecoder) {
     requireNonNull(charsetDecoder, "charsetDecoder must not be null");
     isNotNull();
@@ -148,6 +155,7 @@ public AbstractStringAssert<?> content(CharsetDecoder charsetDecoder) {
    * @return the instant assertion.
    * @throws AssertionError if the actual value is null.
    */
+  @CheckReturnValue
   public AbstractInstantAssert<?> lastModified() {
     isNotNull();
 
@@ -161,6 +169,7 @@ public AbstractInstantAssert<?> lastModified() {
    * @return the assertions for the kind.
    * @throws AssertionError if the actual value is null.
    */
+  @CheckReturnValue
   public JavaFileObjectKindAssert kind() {
     isNotNull();
 

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

@@ -17,6 +17,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import javax.annotation.CheckReturnValue;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.NotThreadSafe;
 import javax.tools.JavaFileObject.Kind;
@@ -90,6 +91,7 @@ public JavaFileObjectKindAssert isOther() {
    * @return the assertions for the file extension of the kind.
    * @throws AssertionError if the kind is null.
    */
+  @CheckReturnValue
   public AbstractStringAssert<?> extension() {
     isNotNull();
 

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

@@ -23,6 +23,7 @@
 import io.github.ascopes.jct.filemanagers.PathFileObject;
 import io.github.ascopes.jct.utils.UtilityClass;
 import java.util.List;
+import javax.annotation.CheckReturnValue;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 import javax.annotation.concurrent.ThreadSafe;
@@ -57,6 +58,7 @@ private JctAssertions() {
    * @param compilation the compilation to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static JctCompilationAssert assertThat(@Nullable JctCompilation compilation) {
     return assertThatCompilation(compilation);
   }
@@ -71,6 +73,7 @@ public static JctCompilationAssert assertThat(@Nullable JctCompilation compilati
    * @param moduleContainerGroup the module container group to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static ModuleContainerGroupAssert assertThat(
       @Nullable ModuleContainerGroup moduleContainerGroup
   ) {
@@ -87,6 +90,7 @@ public static ModuleContainerGroupAssert assertThat(
    * @param outputContainerGroup the output container group to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static OutputContainerGroupAssert assertThat(
       @Nullable OutputContainerGroup outputContainerGroup
   ) {
@@ -103,6 +107,7 @@ public static OutputContainerGroupAssert assertThat(
    * @param packageContainerGroup the package container group to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static PackageContainerGroupAssert assertThat(
       @Nullable PackageContainerGroup packageContainerGroup
   ) {
@@ -119,6 +124,7 @@ public static PackageContainerGroupAssert assertThat(
    * @param diagnostic the diagnostic to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static TraceDiagnosticAssert assertThat(
       @Nullable TraceDiagnostic<? extends JavaFileObject> diagnostic
   ) {
@@ -135,6 +141,7 @@ public static TraceDiagnosticAssert assertThat(
    * @param fileObject the file object to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static JavaFileObjectAssert assertThat(@Nullable JavaFileObject fileObject) {
     return assertThatFileObject(fileObject);
   }
@@ -149,6 +156,7 @@ public static JavaFileObjectAssert assertThat(@Nullable JavaFileObject fileObjec
    * @param fileObject the file object to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static PathFileObjectAssert assertThat(@Nullable PathFileObject fileObject) {
     return assertThatFileObject(fileObject);
   }
@@ -163,6 +171,7 @@ public static PathFileObjectAssert assertThat(@Nullable PathFileObject fileObjec
    * @param kind the diagnostic kind to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static DiagnosticKindAssert assertThat(@Nullable Diagnostic.Kind kind) {
     return assertThatKind(kind);
   }
@@ -177,6 +186,7 @@ public static DiagnosticKindAssert assertThat(@Nullable Diagnostic.Kind kind) {
    * @param kind the Java file object kind to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static JavaFileObjectKindAssert assertThat(@Nullable JavaFileObject.Kind kind) {
     return assertThatKind(kind);
   }
@@ -191,6 +201,7 @@ public static JavaFileObjectKindAssert assertThat(@Nullable JavaFileObject.Kind
    * @param location the location to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static LocationAssert assertThat(@Nullable Location location) {
     return assertThatLocation(location);
   }
@@ -201,6 +212,7 @@ public static LocationAssert assertThat(@Nullable Location location) {
    * @param compilation the compilation to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static JctCompilationAssert assertThatCompilation(@Nullable JctCompilation compilation) {
     return new JctCompilationAssert(compilation);
   }
@@ -211,6 +223,7 @@ public static JctCompilationAssert assertThatCompilation(@Nullable JctCompilatio
    * @param moduleContainerGroup the module container group to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static ModuleContainerGroupAssert assertThatContainerGroup(
       @Nullable ModuleContainerGroup moduleContainerGroup
   ) {
@@ -223,6 +236,7 @@ public static ModuleContainerGroupAssert assertThatContainerGroup(
    * @param outputContainerGroup the output container group to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static OutputContainerGroupAssert assertThatContainerGroup(
       @Nullable OutputContainerGroup outputContainerGroup
   ) {
@@ -235,6 +249,7 @@ public static OutputContainerGroupAssert assertThatContainerGroup(
    * @param packageContainerGroup the package container group to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static PackageContainerGroupAssert assertThatContainerGroup(
       @Nullable PackageContainerGroup packageContainerGroup
   ) {
@@ -247,6 +262,7 @@ public static PackageContainerGroupAssert assertThatContainerGroup(
    * @param diagnostic the diagnostic to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static TraceDiagnosticAssert assertThatDiagnostic(
       @Nullable TraceDiagnostic<? extends JavaFileObject> diagnostic
   ) {
@@ -259,6 +275,7 @@ public static TraceDiagnosticAssert assertThatDiagnostic(
    * @param diagnostics the diagnostics to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static TraceDiagnosticListAssert assertThatDiagnostics(
       @Nullable List<? extends TraceDiagnostic<? extends JavaFileObject>> diagnostics
   ) {
@@ -271,6 +288,7 @@ public static TraceDiagnosticListAssert assertThatDiagnostics(
    * @param fileObject the file object to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static JavaFileObjectAssert assertThatFileObject(@Nullable JavaFileObject fileObject) {
     return new JavaFileObjectAssert(fileObject);
   }
@@ -281,6 +299,7 @@ public static JavaFileObjectAssert assertThatFileObject(@Nullable JavaFileObject
    * @param fileObject the file object to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static PathFileObjectAssert assertThatFileObject(@Nullable PathFileObject fileObject) {
     return new PathFileObjectAssert(fileObject);
   }
@@ -291,6 +310,7 @@ public static PathFileObjectAssert assertThatFileObject(@Nullable PathFileObject
    * @param kind the diagnostic kind to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static DiagnosticKindAssert assertThatKind(@Nullable Diagnostic.Kind kind) {
     return new DiagnosticKindAssert(kind);
   }
@@ -301,6 +321,7 @@ public static DiagnosticKindAssert assertThatKind(@Nullable Diagnostic.Kind kind
    * @param kind the Java file object kind to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static JavaFileObjectKindAssert assertThatKind(@Nullable JavaFileObject.Kind kind) {
     return new JavaFileObjectKindAssert(kind);
   }
@@ -311,6 +332,7 @@ public static JavaFileObjectKindAssert assertThatKind(@Nullable JavaFileObject.K
    * @param location the location to assert on.
    * @return the assertion.
    */
+  @CheckReturnValue
   public static LocationAssert assertThatLocation(@Nullable Location location) {
     return new LocationAssert(location);
   }

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

@@ -21,6 +21,7 @@
 import io.github.ascopes.jct.compilers.JctCompilation;
 import io.github.ascopes.jct.repr.DiagnosticListRepresentation;
 import java.util.Collection;
+import javax.annotation.CheckReturnValue;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.NotThreadSafe;
 import javax.tools.Diagnostic.Kind;
@@ -117,6 +118,7 @@ public JctCompilationAssert isFailure() {
    * @return assertions for the diagnostics.
    * @throws AssertionError if the compilation was null.
    */
+  @CheckReturnValue
   public TraceDiagnosticListAssert diagnostics() {
     isNotNull();
     return new TraceDiagnosticListAssert(actual.getDiagnostics());
@@ -134,6 +136,7 @@ public TraceDiagnosticListAssert diagnostics() {
    *                                  {@link Location#isModuleOrientedLocation() module-oriented}.
    * @throws NullPointerException     if the provided location object is null.
    */
+  @CheckReturnValue
   public PackageContainerGroupAssert packageGroup(Location location) {
     requireNonNull(location, "location must not be null");
 
@@ -162,6 +165,7 @@ public PackageContainerGroupAssert packageGroup(Location location) {
    *                                  {@link Location#isModuleOrientedLocation() module-oriented}.
    * @throws NullPointerException     if the provided location object is null.
    */
+  @CheckReturnValue
   public ModuleContainerGroupAssert moduleGroup(Location location) {
     requireNonNull(location, "location must not be null");
 
@@ -190,6 +194,7 @@ public ModuleContainerGroupAssert moduleGroup(Location location) {
    *                                  {@link Location#isOutputLocation() an output location}.
    * @throws NullPointerException     if the provided location object is null.
    */
+  @CheckReturnValue
   public OutputContainerGroupAssert outputGroup(Location location) {
     requireNonNull(location, "location must not be null");
 
@@ -214,6 +219,7 @@ public OutputContainerGroupAssert outputGroup(Location location) {
    * @return the assertions to perform on the class outputs.
    * @throws AssertionError if the compilation is null.
    */
+  @CheckReturnValue
   public OutputContainerGroupAssert classOutput() {
     return outputGroup(StandardLocation.CLASS_OUTPUT);
   }
@@ -226,6 +232,7 @@ public OutputContainerGroupAssert classOutput() {
    * @return the assertions to perform on the source outputs.
    * @throws AssertionError if the compilation is null.
    */
+  @CheckReturnValue
   public OutputContainerGroupAssert sourceOutput() {
     return outputGroup(StandardLocation.SOURCE_OUTPUT);
   }
@@ -238,6 +245,7 @@ public OutputContainerGroupAssert sourceOutput() {
    * @return the assertions to perform on the header outputs.
    * @throws AssertionError if the compilation is null.
    */
+  @CheckReturnValue
   public OutputContainerGroupAssert generatedHeaders() {
     return outputGroup(StandardLocation.NATIVE_HEADER_OUTPUT);
   }
@@ -250,6 +258,7 @@ public OutputContainerGroupAssert generatedHeaders() {
    * @return the assertions to perform on the class path.
    * @throws AssertionError if the compilation is null.
    */
+  @CheckReturnValue
   public PackageContainerGroupAssert classPath() {
     return packageGroup(StandardLocation.CLASS_PATH);
   }
@@ -262,6 +271,7 @@ public PackageContainerGroupAssert classPath() {
    * @return the assertions to perform on the source path.
    * @throws AssertionError if the compilation is null.
    */
+  @CheckReturnValue
   public PackageContainerGroupAssert sourcePath() {
     return packageGroup(StandardLocation.SOURCE_PATH);
   }
@@ -274,6 +284,7 @@ public PackageContainerGroupAssert sourcePath() {
    * @return the assertions to perform on the source path.
    * @throws AssertionError if the compilation is null.
    */
+  @CheckReturnValue
   public ModuleContainerGroupAssert moduleSourcePath() {
     return moduleGroup(StandardLocation.MODULE_SOURCE_PATH);
   }
@@ -286,6 +297,7 @@ public ModuleContainerGroupAssert moduleSourcePath() {
    * @return the assertions to perform on the module path.
    * @throws AssertionError if the compilation is null.
    */
+  @CheckReturnValue
   public ModuleContainerGroupAssert modulePath() {
     return moduleGroup(StandardLocation.MODULE_PATH);
   }

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

@@ -18,6 +18,7 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 import io.github.ascopes.jct.repr.LocationRepresentation;
+import javax.annotation.CheckReturnValue;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.NotThreadSafe;
 import javax.tools.JavaFileManager.Location;
@@ -124,6 +125,7 @@ public LocationAssert isNotOutputLocation() {
    * @return the string assertions to perform.
    * @throws AssertionError if the location is null.
    */
+  @CheckReturnValue
   public AbstractStringAssert<?> name() {
     isNotNull();