-
Notifications
You must be signed in to change notification settings - Fork 64
Add CheckReturnValue annotation #81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
amaembo
merged 2 commits into
JetBrains:master
from
rillig:roland.illig/CheckReturnValue
Jan 11, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
33 changes: 33 additions & 0 deletions
33
common/src/main/java/org/jetbrains/annotations/CheckReturnValue.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
package org.jetbrains.annotations; | ||
|
||
import java.lang.annotation.ElementType; | ||
import java.lang.annotation.Target; | ||
|
||
/** | ||
* Specifies that the method is impure and that its return value must be used. | ||
* <p> | ||
* For pure methods (annotated with {@code @Contract(pure = true)}), | ||
* it's implied that the resulting value is important, | ||
* so this annotation would be redundant. | ||
* <p> | ||
* Some impure methods have side effects and still require the return value to be used. | ||
* For example, {@link java.io.InputStream#read(byte[])} | ||
* returns the number of bytes actually stored in the byte array. | ||
* Without checking the return value, it's impossible to say how many bytes were actually read. | ||
* <p> | ||
* This annotation should not be used if the return value of the method | ||
* provides only <i>additional</i> information. | ||
* For example, the main purpose of {@link java.util.Collection#add(Object)} | ||
* is to modify the collection, and the return value is only interesting | ||
* when adding an element to a set, to see if the set already contained that element before. | ||
* <p> | ||
* When used on a type, the annotation applies to all methods that do not return {@code void}. | ||
* <p> | ||
* When used on a package, the annotation applies to all types of that package. | ||
* | ||
* @see Contract#pure() | ||
*/ | ||
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE, ElementType.PACKAGE}) | ||
@ApiStatus.Experimental | ||
public @interface CheckReturnValue { | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.