Skip to content

Commit f03f6d7

Browse files
SirCotareSirCotare
committed
add @CheckReturnValue annotation to methods across the codebase
1 parent e435948 commit f03f6d7

30 files changed

Lines changed: 111 additions & 1 deletion

‎pom.xml‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
2+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
34
<modelVersion>4.0.0</modelVersion>
45

56
<parent>
@@ -59,6 +60,14 @@
5960
<optional>true</optional>
6061
</dependency>
6162

63+
<!-- Source: https://mvnrepository.com/artifact/com.google.errorprone/error_prone_annotations -->
64+
<dependency>
65+
<groupId>com.google.errorprone</groupId>
66+
<artifactId>error_prone_annotations</artifactId>
67+
<version>2.50.0</version>
68+
<scope>compile</scope>
69+
</dependency>
70+
6271
<!-- Testing -->
6372
<dependency>
6473
<groupId>org.springframework.security</groupId>

‎src/main/java/it/aboutbits/springboot/testing/persistence/PersistenceAssert.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.persistence;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import it.aboutbits.springboot.testing.spring.BeanAccessor;
45
import it.aboutbits.springboot.toolbox.persistence.ChangeAware;
56
import it.aboutbits.springboot.toolbox.type.identity.EntityId;
@@ -28,6 +29,7 @@ private static EntityManager getEntityManager() {
2829
}
2930

3031
@SuppressWarnings("unused")
32+
@CheckReturnValue
3133
public static <ID extends EntityId<?>, E extends Identified<ID> & ChangeAware, M extends Identified<ID> & ChangeAware> WriteOperationAsserter<ID, E, M> assertThatEntity(
3234
E before,
3335
Class<M> modelClass
@@ -36,6 +38,7 @@ public static <ID extends EntityId<?>, E extends Identified<ID> & ChangeAware, M
3638
}
3739

3840
@SuppressWarnings("unused")
41+
@CheckReturnValue
3942
public static <ID extends EntityId<?>, E extends Identified<ID> & ChangeAware, M extends Identified<ID> & ChangeAware> WriteOperationAsserter<ID, E, M> assertThatEntity(
4043
Collection<E> before,
4144
Class<M> modelClass
@@ -44,6 +47,7 @@ public static <ID extends EntityId<?>, E extends Identified<ID> & ChangeAware, M
4447
}
4548

4649
@SuppressWarnings("unused")
50+
@CheckReturnValue
4751
public static <ID extends EntityId<?>, M extends Identified<ID>> WriteOperationIdAsserter<ID, M> assertThatEntityId(
4852
ID id,
4953
Class<M> modelClass
@@ -52,6 +56,7 @@ public static <ID extends EntityId<?>, M extends Identified<ID>> WriteOperationI
5256
}
5357

5458
@SuppressWarnings("unused")
59+
@CheckReturnValue
5560
public static <ID extends EntityId<?>, M extends Identified<ID>> WriteOperationIdAsserter<ID, M> assertThatEntityId(
5661
Collection<ID> id,
5762
Class<M> modelClass

‎src/main/java/it/aboutbits/springboot/testing/testdata/base/AllTestDataReader.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.testdata.base;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import org.jspecify.annotations.NullMarked;
45

56
import java.util.Comparator;
@@ -24,6 +25,7 @@ public List<ITEM> returnAll() {
2425

2526
@SafeVarargs
2627
@SuppressWarnings("unused")
28+
@CheckReturnValue
2729
public final List<ITEM> returnSorted(Comparator<ITEM>... comparators) {
2830
if (comparators.length == 0) {
2931
throw new IllegalArgumentException("At least one comparator must be provided");
@@ -39,6 +41,7 @@ public final List<ITEM> returnSorted(Comparator<ITEM>... comparators) {
3941

4042
@SafeVarargs
4143
@SuppressWarnings({"unchecked", "unused"})
44+
@CheckReturnValue
4245
public final <U extends Comparable<? super U>> List<ITEM> returnSorted(Function<ITEM, ? extends Comparable<?>>... comparators) {
4346
if (comparators.length == 0) {
4447
throw new IllegalArgumentException("At least one comparator must be provided");
@@ -53,6 +56,7 @@ public final <U extends Comparable<? super U>> List<ITEM> returnSorted(Function<
5356
}
5457

5558
@SuppressWarnings("unused")
59+
@CheckReturnValue
5660
public <U extends Comparable<? super U>> AllAndFiltered<ITEM> returnFiltered(Predicate<ITEM> predicate) {
5761
var all = this.returnAll();
5862
return new AllAndFiltered<>(
@@ -63,6 +67,7 @@ public <U extends Comparable<? super U>> AllAndFiltered<ITEM> returnFiltered(Pre
6367
}
6468

6569
@SuppressWarnings("unused")
70+
@CheckReturnValue
6671
public Set<ITEM> returnSet() {
6772
return new HashSet<>(this.returnAll());
6873
}

‎src/main/java/it/aboutbits/springboot/testing/testdata/base/ModifiableTestDataCreator.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.testdata.base;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import lombok.extern.slf4j.Slf4j;
45
import org.jspecify.annotations.NullMarked;
56
import org.jspecify.annotations.Nullable;
@@ -31,6 +32,7 @@ protected ModifiableTestDataCreator(int count) {
3132
}
3233

3334
@SuppressWarnings({"unchecked", "unused"})
35+
@CheckReturnValue
3436
public CREATOR modifyParameter(BiFunction<PARAMETER, Integer, PARAMETER> parameterMutator) {
3537
this.parameterMutator = (parameter, index) -> {
3638
mutatorCalled = true;
@@ -41,6 +43,7 @@ public CREATOR modifyParameter(BiFunction<PARAMETER, Integer, PARAMETER> paramet
4143
}
4244

4345
@SuppressWarnings({"unchecked", "unused"})
46+
@CheckReturnValue
4447
public CREATOR modifyParameter(UnaryOperator<PARAMETER> parameterMutator) {
4548
this.parameterMutator = (parameter, index) -> {
4649
mutatorCalled = true;
@@ -51,12 +54,14 @@ public CREATOR modifyParameter(UnaryOperator<PARAMETER> parameterMutator) {
5154
}
5255

5356
@SuppressWarnings({"unchecked", "unused"})
57+
@CheckReturnValue
5458
public CREATOR modifyResult(ObjIntConsumer<ITEM> resultMutator) {
5559
this.resultMutator = resultMutator;
5660
return (CREATOR) this;
5761
}
5862

5963
@SuppressWarnings({"unchecked", "unused"})
64+
@CheckReturnValue
6065
public CREATOR modifyResult(Consumer<ITEM> resultMutator) {
6166
this.resultMutator = (item, index) -> resultMutator.accept(item);
6267
return (CREATOR) this;

‎src/main/java/it/aboutbits/springboot/testing/testdata/base/TestDataCreator.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.testdata.base;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import it.aboutbits.springboot.testing.testdata.FakerExtended;
45
import org.jspecify.annotations.NullMarked;
56

@@ -28,17 +29,20 @@ public void commit() {
2829
}
2930

3031
@SuppressWarnings("unused")
32+
@CheckReturnValue
3133
public ITEM returnFirst() {
3234
return create().getFirst();
3335
}
3436

3537
@SuppressWarnings("unused")
38+
@CheckReturnValue
3639
public List<ITEM> returnAll() {
3740
return create();
3841
}
3942

4043
@SafeVarargs
4144
@SuppressWarnings("unused")
45+
@CheckReturnValue
4246
public final List<ITEM> returnSorted(Comparator<ITEM>... comparators) {
4347
if (comparators.length == 0) {
4448
throw new IllegalArgumentException("At least one comparator must be provided");
@@ -54,6 +58,7 @@ public final List<ITEM> returnSorted(Comparator<ITEM>... comparators) {
5458

5559
@SafeVarargs
5660
@SuppressWarnings({"unchecked", "unused"})
61+
@CheckReturnValue
5762
public final <U extends Comparable<? super U>> List<ITEM> returnSorted(Function<ITEM, ? extends Comparable<?>>... comparators) {
5863
if (comparators.length == 0) {
5964
throw new IllegalArgumentException("At least one comparator must be provided");
@@ -68,6 +73,7 @@ public final <U extends Comparable<? super U>> List<ITEM> returnSorted(Function<
6873
}
6974

7075
@SuppressWarnings("unused")
76+
@CheckReturnValue
7177
public Set<ITEM> returnSet() {
7278
return new HashSet<>(create());
7379
}

‎src/main/java/it/aboutbits/springboot/testing/validation/core/BaseValidationAssert.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.validation.core;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import it.aboutbits.springboot.toolbox.type.CustomType;
45
import jakarta.validation.Valid;
56
import lombok.AccessLevel;
@@ -49,13 +50,15 @@ public static void registerNonBeanType(Class<?> type) {
4950
NON_BEAN_TYPES.add(type);
5051
}
5152

53+
@CheckReturnValue
5254
public <P> CallBuilder<R, P> of(P parameterUnderTest) {
5355
this.parameterUnderTest = parameterUnderTest;
5456
ruleBuilder.setTriggerValidation(this::assertValidation);
5557
return new CallBuilder<>(this);
5658
}
5759

5860
@SuppressWarnings("unused")
61+
@CheckReturnValue
5962
public AnnotationChecker calling(
6063
Class<?> classUnderTest,
6164
String methodName,
@@ -97,17 +100,20 @@ public static final class CallBuilder<R extends BaseRuleBuilder<?>, P> {
97100
private final BaseValidationAssert<R> parent;
98101

99102
@SuppressWarnings("unused")
103+
@CheckReturnValue
100104
public R calling(Consumer<P> functionToCallWithParameter) {
101105
parent.setFunctionToCallWithParameter(functionToCallWithParameter);
102106
return parent.ruleBuilder;
103107
}
104108

105109
@SuppressWarnings("unused")
110+
@CheckReturnValue
106111
public R usingBeanValidation() {
107112
return parent.ruleBuilder;
108113
}
109114

110115
@SuppressWarnings({"unused", "unchecked"})
116+
@CheckReturnValue
111117
public <ID> R calling(
112118
BiConsumer<ID, P> functionToCallWithParameter,
113119
ID id
@@ -119,6 +125,7 @@ public <ID> R calling(
119125
}
120126

121127
@SuppressWarnings({"unused", "unchecked"})
128+
@CheckReturnValue
122129
public <A, B> R calling(
123130
TriConsumer<A, B, P> functionToCallWithParameter,
124131
A a,

‎src/main/java/it/aboutbits/springboot/testing/validation/rule/BetweenRule.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.validation.rule;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import it.aboutbits.springboot.testing.validation.core.BaseRuleBuilder;
45
import it.aboutbits.springboot.testing.validation.core.Rule;
56
import it.aboutbits.springboot.testing.validation.core.ValidationRulesData;
@@ -10,6 +11,7 @@
1011
@SuppressWarnings("unchecked")
1112
@NullMarked
1213
public interface BetweenRule<V extends BaseRuleBuilder<?>> extends ValidationRulesData {
14+
@CheckReturnValue
1315
default V between(String property, long min, long max) {
1416
addRule(
1517
new Rule(property, BiggerThanValueSource.class, max)

‎src/main/java/it/aboutbits/springboot/testing/validation/rule/FutureRule.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.validation.rule;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import it.aboutbits.springboot.testing.validation.core.BaseRuleBuilder;
45
import it.aboutbits.springboot.testing.validation.core.Rule;
56
import it.aboutbits.springboot.testing.validation.core.ValidationRulesData;
@@ -9,6 +10,7 @@
910
@SuppressWarnings("unchecked")
1011
@NullMarked
1112
public interface FutureRule<V extends BaseRuleBuilder<?>> extends ValidationRulesData {
13+
@CheckReturnValue
1214
default V future(String property) {
1315
addRule(
1416
new Rule(property, PastValueSource.class)

‎src/main/java/it/aboutbits/springboot/testing/validation/rule/MaxRule.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.validation.rule;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import it.aboutbits.springboot.testing.validation.core.BaseRuleBuilder;
45
import it.aboutbits.springboot.testing.validation.core.Rule;
56
import it.aboutbits.springboot.testing.validation.core.ValidationRulesData;
@@ -9,6 +10,7 @@
910
@SuppressWarnings("unchecked")
1011
@NullMarked
1112
public interface MaxRule<V extends BaseRuleBuilder<?>> extends ValidationRulesData {
13+
@CheckReturnValue
1214
default V max(String property, long max) {
1315
addRule(
1416
new Rule(property, BiggerThanValueSource.class, max)

‎src/main/java/it/aboutbits/springboot/testing/validation/rule/MinRule.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package it.aboutbits.springboot.testing.validation.rule;
22

3+
import com.google.errorprone.annotations.CheckReturnValue;
34
import it.aboutbits.springboot.testing.validation.core.BaseRuleBuilder;
45
import it.aboutbits.springboot.testing.validation.core.Rule;
56
import it.aboutbits.springboot.testing.validation.core.ValidationRulesData;
@@ -9,6 +10,7 @@
910
@SuppressWarnings("unchecked")
1011
@NullMarked
1112
public interface MinRule<V extends BaseRuleBuilder<?>> extends ValidationRulesData {
13+
@CheckReturnValue
1214
default V min(String property, long min) {
1315
addRule(
1416
new Rule(property, LessThanValueSource.class, min)

0 commit comments

Comments
 (0)