Skip to content

Commit 1bf8cd6

Browse files
committed
Deprecate org.assertj.core.util.CanIgnoreReturnValue in favor of org.assertj.core.annotation.CanIgnoreReturnValue
1 parent 72d08b2 commit 1bf8cd6

12 files changed

Lines changed: 40 additions & 10 deletions
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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.Retention;
17+
import java.lang.annotation.RetentionPolicy;
18+
import java.lang.annotation.Target;
19+
20+
/**
21+
* Annotation to skip "CheckReturnValue" check.
22+
*
23+
* @since 3.27.4
24+
*/
25+
@Target({ ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PACKAGE, ElementType.TYPE })
26+
public @interface CanIgnoreReturnValue {
27+
}

assertj-core/src/main/java/org/assertj/core/api/AbstractSoftAssertions.java

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

1717
import java.util.List;
1818

19+
import org.assertj.core.annotation.CanIgnoreReturnValue;
1920
import org.assertj.core.error.AssertionErrorCreator;
2021
import org.assertj.core.internal.Failures;
21-
import org.assertj.core.util.CanIgnoreReturnValue;
2222

2323
public abstract class AbstractSoftAssertions extends DefaultAssertionErrorCollector
2424
implements SoftAssertionsProvider, InstanceOfAssertFactories {

assertj-core/src/main/java/org/assertj/core/api/Assertions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
import java.util.stream.LongStream;
7979
import java.util.stream.Stream;
8080

81+
import org.assertj.core.annotation.CanIgnoreReturnValue;
8182
import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
8283
import org.assertj.core.api.filter.FilterOperator;
8384
import org.assertj.core.api.filter.Filters;
@@ -105,7 +106,6 @@
105106
import org.assertj.core.presentation.Representation;
106107
import org.assertj.core.presentation.StandardRepresentation;
107108
import org.assertj.core.presentation.UnicodeRepresentation;
108-
import org.assertj.core.util.CanIgnoreReturnValue;
109109
import org.assertj.core.util.CheckReturnValue;
110110
import org.assertj.core.util.Files;
111111
import org.assertj.core.util.Paths;

assertj-core/src/main/java/org/assertj/core/api/AssertionsForClassTypes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import java.util.concurrent.CompletableFuture;
4343
import java.util.regex.Matcher;
4444

45+
import org.assertj.core.annotation.CanIgnoreReturnValue;
4546
import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
4647
import org.assertj.core.api.filter.FilterOperator;
4748
import org.assertj.core.api.filter.Filters;
@@ -59,7 +60,6 @@
5960
import org.assertj.core.groups.Properties;
6061
import org.assertj.core.groups.Tuple;
6162
import org.assertj.core.presentation.StandardRepresentation;
62-
import org.assertj.core.util.CanIgnoreReturnValue;
6363
import org.assertj.core.util.CheckReturnValue;
6464
import org.assertj.core.util.Files;
6565
import org.assertj.core.util.Paths;

assertj-core/src/main/java/org/assertj/core/api/BDDAssertions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373
import java.util.stream.LongStream;
7474
import java.util.stream.Stream;
7575

76+
import org.assertj.core.annotation.CanIgnoreReturnValue;
7677
import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
7778
import org.assertj.core.api.filter.FilterOperator;
7879
import org.assertj.core.api.filter.InFilter;
@@ -96,7 +97,6 @@
9697
import org.assertj.core.presentation.Representation;
9798
import org.assertj.core.presentation.StandardRepresentation;
9899
import org.assertj.core.presentation.UnicodeRepresentation;
99-
import org.assertj.core.util.CanIgnoreReturnValue;
100100
import org.assertj.core.util.CheckReturnValue;
101101

102102
/**

assertj-core/src/main/java/org/assertj/core/api/Fail.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
*/
1313
package org.assertj.core.api;
1414

15+
import org.assertj.core.annotation.CanIgnoreReturnValue;
1516
import org.assertj.core.internal.Failures;
16-
import org.assertj.core.util.CanIgnoreReturnValue;
1717

1818
/**
1919
* Common failures.

assertj-core/src/main/java/org/assertj/core/api/Java6Assertions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
4343
import java.util.concurrent.atomic.AtomicStampedReference;
4444

45+
import org.assertj.core.annotation.CanIgnoreReturnValue;
4546
import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
4647
import org.assertj.core.api.filter.FilterOperator;
4748
import org.assertj.core.api.filter.Filters;
@@ -60,7 +61,6 @@
6061
import org.assertj.core.groups.Properties;
6162
import org.assertj.core.groups.Tuple;
6263
import org.assertj.core.presentation.StandardRepresentation;
63-
import org.assertj.core.util.CanIgnoreReturnValue;
6464
import org.assertj.core.util.CheckReturnValue;
6565
import org.assertj.core.util.Files;
6666
import org.assertj.core.util.URLs;

assertj-core/src/main/java/org/assertj/core/api/Java6BDDAssertions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
4141
import java.util.concurrent.atomic.AtomicStampedReference;
4242

43+
import org.assertj.core.annotation.CanIgnoreReturnValue;
4344
import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
44-
import org.assertj.core.util.CanIgnoreReturnValue;
4545
import org.assertj.core.util.CheckReturnValue;
4646

4747
/**

assertj-core/src/main/java/org/assertj/core/api/Java6BDDSoftAssertionsProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
4141
import java.util.concurrent.atomic.AtomicStampedReference;
4242

43+
import org.assertj.core.annotation.CanIgnoreReturnValue;
4344
import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
44-
import org.assertj.core.util.CanIgnoreReturnValue;
4545
import org.assertj.core.util.CheckReturnValue;
4646

4747
/**

assertj-core/src/main/java/org/assertj/core/api/Java6StandardSoftAssertionsProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
import java.util.concurrent.atomic.AtomicReferenceFieldUpdater;
4141
import java.util.concurrent.atomic.AtomicStampedReference;
4242

43+
import org.assertj.core.annotation.CanIgnoreReturnValue;
4344
import org.assertj.core.api.ThrowableAssert.ThrowingCallable;
44-
import org.assertj.core.util.CanIgnoreReturnValue;
4545
import org.assertj.core.util.CheckReturnValue;
4646

4747
/**

0 commit comments

Comments
 (0)