Skip to content

Commit 43e8b65

Browse files
scordioscordio
committed
Deprecate org.assertj.core.util.CheckReturnValue in favor of org.assertj.core.annotation.CheckReturnValue 
1 parent 1bf8cd6 commit 43e8b65

70 files changed

Lines changed: 97 additions & 77 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎assertj-core/src/main/java/org/assertj/core/annotation/Beta.java‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,6 @@
3232
*
3333
* @since 3.27.4
3434
*/
35-
@Retention(RetentionPolicy.CLASS)
36-
@Target({
37-
ElementType.ANNOTATION_TYPE,
38-
ElementType.CONSTRUCTOR,
39-
ElementType.FIELD,
40-
ElementType.METHOD,
41-
ElementType.TYPE
42-
})
35+
@Target({ ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
4336
public @interface Beta {
4437
}

‎assertj-core/src/main/java/org/assertj/core/annotation/CanIgnoreReturnValue.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
package org.assertj.core.annotation;
1414

1515
import java.lang.annotation.ElementType;
16-
import java.lang.annotation.Retention;
17-
import java.lang.annotation.RetentionPolicy;
1816
import java.lang.annotation.Target;
1917

2018
/**

‎assertj-core/src/main/java/org/assertj/core/annotation/CheckReturnValue.java‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/*
2+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
3+
* the License. You may obtain a copy of the License at
4+
*
5+
* http://www.apache.org/licenses/LICENSE-2.0
6+
*
7+
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
8+
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
9+
* specific language governing permissions and limitations under the License.
10+
*
11+
* Copyright 2012-2025 the original author or authors.
12+
*/
13+
package org.assertj.core.annotation;
14+
15+
import java.lang.annotation.ElementType;
16+
import java.lang.annotation.Target;
17+
18+
/**
19+
* Findbugs handles any annotation with name "CheckReturnValue" in return value check.
20+
*
21+
* @see <a href="https://github.com/findbugsproject/findbugs/blob/264ae7baf890d2b347d91805c90057062b5dcb1e/findbugs/src/java/edu/umd/cs/findbugs/detect/BuildCheckReturnAnnotationDatabase.java#L120">Findbugs source code</a>
22+
* @since 3.27.4
23+
*/
24+
@Target({ ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PACKAGE, ElementType.TYPE })
25+
public @interface CheckReturnValue {
26+
}

‎assertj-core/src/main/java/org/assertj/core/api/AbstractAssert.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
import java.util.function.Predicate;
3838
import java.util.function.Supplier;
3939

40+
import org.assertj.core.annotation.CheckReturnValue;
4041
import org.assertj.core.api.recursive.assertion.RecursiveAssertionConfiguration;
4142
import org.assertj.core.api.recursive.comparison.RecursiveComparisonConfiguration;
4243
import org.assertj.core.configuration.ConfigurationProvider;
@@ -52,7 +53,6 @@
5253
import org.assertj.core.internal.Objects;
5354
import org.assertj.core.presentation.PredicateDescription;
5455
import org.assertj.core.presentation.Representation;
55-
import org.assertj.core.util.CheckReturnValue;
5656
import org.assertj.core.util.VisibleForTesting;
5757

5858
/**

‎assertj-core/src/main/java/org/assertj/core/api/AbstractBigDecimalAssert.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
import java.math.BigDecimal;
1818
import java.util.Comparator;
1919

20+
import org.assertj.core.annotation.CheckReturnValue;
2021
import org.assertj.core.data.Offset;
2122
import org.assertj.core.data.Percentage;
2223
import org.assertj.core.internal.BigDecimals;
2324
import org.assertj.core.internal.ComparatorBasedComparisonStrategy;
24-
import org.assertj.core.util.CheckReturnValue;
2525
import org.assertj.core.util.VisibleForTesting;
2626

2727
/**

‎assertj-core/src/main/java/org/assertj/core/api/AbstractBigIntegerAssert.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
import java.math.BigInteger;
1616
import java.util.Comparator;
1717

18+
import org.assertj.core.annotation.CheckReturnValue;
1819
import org.assertj.core.data.Offset;
1920
import org.assertj.core.data.Percentage;
2021
import org.assertj.core.internal.BigIntegers;
2122
import org.assertj.core.internal.ComparatorBasedComparisonStrategy;
22-
import org.assertj.core.util.CheckReturnValue;
2323
import org.assertj.core.util.VisibleForTesting;
2424

2525
/**

‎assertj-core/src/main/java/org/assertj/core/api/AbstractByteArrayAssert.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
import java.util.Base64;
2121
import java.util.Comparator;
2222

23+
import org.assertj.core.annotation.CheckReturnValue;
2324
import org.assertj.core.data.Index;
2425
import org.assertj.core.internal.ByteArrays;
2526
import org.assertj.core.internal.ComparatorBasedComparisonStrategy;
26-
import org.assertj.core.util.CheckReturnValue;
2727
import org.assertj.core.util.VisibleForTesting;
2828

2929
public abstract class AbstractByteArrayAssert<SELF extends AbstractByteArrayAssert<SELF>>

‎assertj-core/src/main/java/org/assertj/core/api/AbstractByteAssert.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@
1414

1515
import java.util.Comparator;
1616

17+
import org.assertj.core.annotation.CheckReturnValue;
1718
import org.assertj.core.data.Offset;
1819
import org.assertj.core.data.Percentage;
1920
import org.assertj.core.internal.Bytes;
2021
import org.assertj.core.internal.ComparatorBasedComparisonStrategy;
21-
import org.assertj.core.util.CheckReturnValue;
2222
import org.assertj.core.util.VisibleForTesting;
2323

2424
/**

‎assertj-core/src/main/java/org/assertj/core/api/AbstractCharArrayAssert.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616

1717
import java.util.Comparator;
1818

19+
import org.assertj.core.annotation.CheckReturnValue;
1920
import org.assertj.core.data.Index;
2021
import org.assertj.core.internal.CharArrays;
2122
import org.assertj.core.internal.ComparatorBasedComparisonStrategy;
22-
import org.assertj.core.util.CheckReturnValue;
2323
import org.assertj.core.util.VisibleForTesting;
2424

2525
public abstract class AbstractCharArrayAssert<SELF extends AbstractCharArrayAssert<SELF>>

‎assertj-core/src/main/java/org/assertj/core/api/AbstractCharSequenceAssert.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@
4646
import java.util.regex.Pattern;
4747
import java.util.regex.PatternSyntaxException;
4848

49+
import org.assertj.core.annotation.CheckReturnValue;
4950
import org.assertj.core.internal.ComparatorBasedComparisonStrategy;
5051
import org.assertj.core.internal.Strings;
51-
import org.assertj.core.util.CheckReturnValue;
5252
import org.assertj.core.util.VisibleForTesting;
5353

5454
/**

0 commit comments

Comments
 (0)