Skip to content

@SideEffectFree annotations #282

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.

Sign up for GitHub

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

Open
mernst wants to merge 7 commits into
base: master
Choose a base branch
from
Open

@SideEffectFree annotations #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7f0db9b
`@SideEffectFree` annotations
mernst Jul 13, 2026
0acd195
Update qualifiers
mernst Jul 13, 2026
9713560
Add `import` statements
mernst Jul 13, 2026
c93ca98
Add `import` statements
mernst Jul 13, 2026
21c0697
Add `import` statements
mernst Jul 13, 2026
eeaace3
Update annotations, especially on `drainTo()`
mernst Jul 14, 2026
b12126e
More purity annotations
mernst Jul 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ them cause build failures, especially in the interim builds):

Annotations for classes that exist in JDK version X but were removed later
appear in jdkX.astub files, such as jdk11.astub, in repository
<https://github.com/typetools/checker-framework/> .
<https://github.com/typetools/checker-framework/>.

## Building

Expand Down Expand Up @@ -53,7 +53,7 @@ Thanks in advance for your contributions!

When adding annotations, please annotate an entire file at a time, and add an
`@AnnotatedFor` annotation on the class declaration. The rationale is explained
at <https://checkerframework.org/manual/#library-tips-fully-annotate> .
at <https://checkerframework.org/manual/#library-tips-fully-annotate>.

## Relationship to other repositories

Expand Down
Binary file modified checker-qual.jar
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions src/java.base/share/classes/java/io/BufferedReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
import org.checkerframework.dataflow.qual.Pure;
import org.checkerframework.framework.qual.AnnotatedFor;
import org.checkerframework.framework.qual.DoesNotUnrefineReceiver;
// import org.checkerframework.dataflow.qual.SideEffectsOnly;
import org.checkerframework.dataflow.qual.SideEffectsOnly;

import java.util.Iterator;
import java.util.NoSuchElementException;
Expand Down Expand Up @@ -709,7 +709,7 @@ public boolean hasNext() {
}

@Override
// @SideEffectsOnly("this")
@SideEffectsOnly("this")
@DoesNotUnrefineReceiver("modifiability")
public String next(/*@NonEmpty Iterator<String> this*/) {
if (nextLine != null || hasNext()) {
Expand Down
4 changes: 2 additions & 2 deletions src/java.base/share/classes/java/lang/AbstractStringBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import org.checkerframework.dataflow.qual.Pure;
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.framework.qual.AnnotatedFor;
// import org.checkerframework.dataflow.qual.SideEffectsOnly;
import org.checkerframework.dataflow.qual.SideEffectsOnly;

import jdk.internal.math.DoubleToDecimal;
import jdk.internal.math.FloatToDecimal;
Expand Down Expand Up @@ -522,7 +522,7 @@ public int codePointBefore(@Positive int index) {
* {@code dst.length}
* </ul>
*/
// @SideEffectsOnly("#3")
@SideEffectsOnly("#3")
public void getChars(@NonNegative int srcBegin, @NonNegative int srcEnd, char[] dst, @IndexOrHigh({"#3"}) int dstBegin)
{
Preconditions.checkFromToIndex(srcBegin, srcEnd, count, Preconditions.SIOOBE_FORMATTER); // compatible to old version
Expand Down
6 changes: 3 additions & 3 deletions src/java.base/share/classes/java/lang/CharSequence.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.framework.qual.AnnotatedFor;
import org.checkerframework.framework.qual.DoesNotUnrefineReceiver;
// import org.checkerframework.dataflow.qual.SideEffectsOnly;
import org.checkerframework.dataflow.qual.SideEffectsOnly;

import java.util.NoSuchElementException;
import java.util.Objects;
Expand Down Expand Up @@ -175,7 +175,7 @@ public boolean hasNext() {
return cur < length();
}

// @SideEffectsOnly("this")
@SideEffectsOnly("this")
@DoesNotUnrefineReceiver("modifiability")
public int nextInt(@NonEmpty CharIterator this) {
if (hasNext()) {
Expand Down Expand Up @@ -253,7 +253,7 @@ public boolean hasNext() {
return cur < length();
}

// @SideEffectsOnly("this")
@SideEffectsOnly("this")
@DoesNotUnrefineReceiver("modifiability")
public int nextInt(@NonEmpty CodePointIterator this) {
final int length = length();
Expand Down
4 changes: 2 additions & 2 deletions src/java.base/share/classes/java/lang/StackStreamFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

import org.checkerframework.checker.nonempty.qual.EnsuresNonEmptyIf;
import org.checkerframework.dataflow.qual.Pure;
// import org.checkerframework.dataflow.qual.SideEffectsOnly;
import org.checkerframework.dataflow.qual.SideEffectsOnly;

import jdk.internal.reflect.MethodAccessor;
import jdk.internal.reflect.ConstructorAccessor;
Expand Down Expand Up @@ -376,7 +376,7 @@ private void setContinuation(Continuation cont) {
*
* @see #tryNextFrame
*/
// @SideEffectsOnly("this")
@SideEffectsOnly("this")
final Class<?> nextFrame() {
if (!hasNext()) {
return null;
Expand Down
4 changes: 2 additions & 2 deletions src/java.base/share/classes/java/lang/String.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.framework.qual.AnnotatedFor;
import org.checkerframework.framework.qual.CFComment;
// import org.checkerframework.dataflow.qual.SideEffectsOnly;
import org.checkerframework.dataflow.qual.SideEffectsOnly;

import java.io.ObjectStreamField;
import java.io.UnsupportedEncodingException;
Expand Down Expand Up @@ -1788,7 +1788,7 @@ public int codePointBefore(@LTEqLengthOf({"this"}) @Positive int index) {
* <li>{@code dstBegin+(srcEnd-srcBegin)} is larger than
* {@code dst.length}</ul>
*/
// @SideEffectsOnly("#3")
@SideEffectsOnly("#3")
public void getChars(@IndexOrHigh({"this"}) int srcBegin, @IndexOrHigh({"this"}) int srcEnd, char @GuardSatisfied [] dst, @IndexOrHigh({"#3"}) int dstBegin) {
checkBoundsBeginEnd(srcBegin, srcEnd, length());
checkBoundsOffCount(dstBegin, srcEnd - srcBegin, dst.length);
Expand Down
4 changes: 2 additions & 2 deletions src/java.base/share/classes/java/lang/StringBuffer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import org.checkerframework.dataflow.qual.Pure;
import org.checkerframework.dataflow.qual.SideEffectFree;
import org.checkerframework.framework.qual.AnnotatedFor;
// import org.checkerframework.dataflow.qual.SideEffectsOnly;
import org.checkerframework.dataflow.qual.SideEffectsOnly;

import java.io.IOException;
import java.io.ObjectInputStream;
Expand Down Expand Up @@ -304,7 +304,7 @@ public synchronized int offsetByCodePoints(int index, int codePointOffset) {
/**
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
// @SideEffectsOnly("#3")
@SideEffectsOnly("#3")
@Override
public synchronized void getChars(int srcBegin, int srcEnd, char[] dst,
@IndexOrHigh({"#3"}) int dstBegin)
Expand Down
Loading
Loading