#48 ZIP file to PR, java runtime library #56

Bananeweizen · 2017-11-11T17:30:09Z

This is the merged ZIP file contribution for the Java runtime.

all signature changes of existing methods in java/java have been reviewed by me (and only 4 of the
suggested changes were rejected by me).
changes in java/javax have not been reviewed.
new method signatures have not been reviewed (but will be crosschecked over the next days by using them in my own projects).

This is the merged ZIP file contribution for the Java runtime. All changes in java/java have been reviewed by me (and only 4 of the suggested changes were rejected by me). Changes in java/javax have not been reviewed.

Bananeweizen · 2017-11-13T06:39:11Z

libraries/java/java/lang/String.eea

@@ -13,7 +61,7 @@ contains
 (L1java/lang/CharSequence;)Z
 contentEquals
 (Ljava/lang/CharSequence;)Z
- (L0java/lang/CharSequence;)Z
+ (L1java/lang/CharSequence;)Z


This one really was wrong before, the argument is dereferenced.

Bananeweizen · 2017-11-13T06:41:27Z

libraries/java/java/lang/String.eea

 intern
 ()Ljava/lang/String;
 ()L1java/lang/String;
 join
 (Ljava/lang/CharSequence;Ljava/lang/Iterable<+Ljava/lang/CharSequence;>;)Ljava/lang/String;
- (L1java/lang/CharSequence;L1java/lang/Iterable<+1L1java/lang/CharSequence;>;)L1java/lang/String;
+ (L1java/lang/CharSequence;L1java/lang/Iterable<+L0java/lang/CharSequence;>;)L1java/lang/String;


this and the one below were wrong before. The joined collections must be non-null, however the elements in there can be null, since StringBuilder deals with appending null.

Bananeweizen · 2017-11-13T06:43:28Z

libraries/java/java/time/Duration.eea

@@ -22,16 +25,19 @@ from
 (L1java/time/temporal/TemporalAmount;)L1java/time/Duration;
 get
 (Ljava/time/temporal/TemporalUnit;)J
- (L0java/time/temporal/TemporalUnit;)J
+ (L1java/time/temporal/TemporalUnit;)J


This is kind of "interpretation dependent". Null is accepted, but will throw UnsupportedTemporalTypeException, therefore it makes sense to assume NonNull.

Bananeweizen · 2017-11-13T06:57:29Z

Note for reviewers: I've marked the 4 places with actual signature changes in the review. Everything else is just new or more annotations. So if you review those 4 places, you can afterwards accept and merge rather easily.

vorburger

LGTM - it seems like @Bananeweizen you've spent some time looking these over.. I'm fine to merge this as is, but want to give others a chance to review.

Let's say that if there are no other feedback (e.g. from @maggu2810 @sylvainlaurent @kwin@ctron ) within 1 week, then I'll merge this one without further comment.

maggu2810 · 2017-11-13T12:23:42Z

I would give it a go. If there is some stuff wrong, it could be fixed later.

sylvainlaurent · 2017-11-21T21:20:17Z

libraries/java/java/lang/Integer.eea

+ (L0java/lang/Object;)Z
+getInteger
+ (Ljava/lang/String;)Ljava/lang/Integer;
+ (L0java/lang/String;)L1java/lang/Integer;


incorrect, getInteger(String) may return null

sylvainlaurent · 2017-11-21T21:21:52Z

libraries/java/java/util/Collection.eea

+ (L1java/util/Collection<+TE;>;)Z
+contains
+ (Ljava/lang/Object;)Z
+ (Ljava/lang/Object;)Z


accepts null param

sylvainlaurent · 2017-11-21T21:22:27Z

libraries/java/java/util/Collection.eea

+ ()L1java/util/stream/Stream<T+E;>;
+remove
+ (Ljava/lang/Object;)Z
+ (Ljava/lang/Object;)Z


accepts null param

sylvainlaurent · 2017-11-21T21:30:01Z

libraries/java/java/io/StringWriter.eea

+
+append
+ (Ljava/lang/CharSequence;II)Ljava/io/StringWriter;
+ (L1java/lang/CharSequence;II)L1java/io/StringWriter;


null CharSequence is actually accepted

sylvainlaurent · 2017-11-21T21:37:00Z

libraries/java/java/lang/Class.eea

@@ -1,13 +1,169 @@
 class java/lang/Class
+classValueMap
+ Ljava/lang/ClassValue$ClassValueMap;
+ Ljava/lang/ClassValue$ClassValueMap;


I don't think user code would ever reference this field

This one is from the original contribution, not from me. However, I tend to add annotations for private fields also during the analysis, if there is some proof. That makes it easier to later annotate their getters and related methods, even if those don't immediately proof null/nonnull on their own. What do others think about that?

my view on this point would be that if it doesn't cause any harm, then why not

sylvainlaurent · 2017-11-21T21:57:12Z

libraries/java/java/lang/System.eea

+
+out
+ Ljava/io/PrintStream;
+ L0java/io/PrintStream;


this is technically correct, but it never occurs that it's null. And we would have eclipse warnings/errors for a mere System.out.println(...)
same thing for in and err

I have had similar doubts. In my personal project I have meanwhile also removed this annotation for the same reason of it not being pragmatic.

It is possible for System.out to be null. Some piece of code can set it to null. I am not sure why they would do that in the general case. However, I have seen it done in 1 case.

Also, by marking it nullable, then the programmer has to go through more hoops to use it. This encourages using a logger instead.

sylvainlaurent · 2017-11-21T22:31:05Z

libraries/java/java/util/Optional.eea

@@ -13,4 +28,13 @@ ofNullable
 <T:Ljava/lang/Object;>(T0T;)L1java/util/Optional<TT;>;
 orElse
 (TT;)TT;
- (T0T;)TT;
+ (T0T;)T0T;


debatable... I wish there was an equivalent to @contract or @polynull in jdt

sylvainlaurent · 2017-11-21T22:32:41Z

libraries/java/java/util/Properties.eea

+
+setProperty
+ (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object;
+ (L0java/lang/String;L0java/lang/String;)L0java/lang/Object;


incorrect: neither key nor value can be null

sylvainlaurent · 2017-11-21T22:43:05Z

libraries/java/java/util/concurrent/LinkedTransferQueue.eea

+
+poll
+ (JLjava/util/concurrent/TimeUnit;)TE;
+ (JL1java/util/concurrent/TimeUnit;)T1E;


according to java.util.concurrent.BlockingQueue.poll(long, TimeUnit) null is returned if times out without thread interruption

vorburger · 2017-11-23T19:56:09Z

@Bananeweizen are you planning to update this one some time, based on @sylvainlaurent feedback?

vorburger · 2020-03-23T20:06:39Z

If anyone is reading this and wants to rebase this PR and resolve merge conflicts, we could merge it.

vorburger · 2020-03-23T20:07:48Z

Maybe @simoneparca is interested? Given his #89.

J-N-K · 2021-03-04T19:05:51Z

I would really appreciate seeing the missing annotations, but since this did not have activity for a year now and can't be merged due to conflicts, I'm closing here. I promise that I'll review ASAP if someone comes up with a new PR for this.

lastnpe#48 ZIP file to PR, java runtime library

0e78b63

This is the merged ZIP file contribution for the Java runtime. All changes in java/java have been reviewed by me (and only 4 of the suggested changes were rejected by me). Changes in java/javax have not been reviewed.

Bananeweizen commented Nov 13, 2017

View reviewed changes

vorburger mentioned this pull request Nov 13, 2017

154 eea files #48

Open

vorburger approved these changes Nov 13, 2017

View reviewed changes

sylvainlaurent requested changes Nov 21, 2017

View reviewed changes

This was referenced Oct 11, 2020

add annotations for Stream #99

Merged

Fixes found while using the EEA #103

Merged

J-N-K mentioned this pull request Nov 8, 2020

fixes and additions to java.* #117

Merged

J-N-K closed this Mar 4, 2021

J-N-K mentioned this pull request Jun 29, 2021

[java.io] add complete annotations for java.io.File #143

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#48 ZIP file to PR, java runtime library #56

#48 ZIP file to PR, java runtime library #56

Bananeweizen commented Nov 11, 2017 •

edited

Loading

Bananeweizen Nov 13, 2017

Bananeweizen Nov 13, 2017

Bananeweizen Nov 13, 2017

Bananeweizen commented Nov 13, 2017

vorburger left a comment

maggu2810 commented Nov 13, 2017

sylvainlaurent Nov 21, 2017

sylvainlaurent Nov 21, 2017

sylvainlaurent Nov 21, 2017

sylvainlaurent Nov 21, 2017

sylvainlaurent Nov 21, 2017

Bananeweizen Nov 22, 2017 •

edited

Loading

vorburger Nov 23, 2017

sylvainlaurent Nov 21, 2017

Bananeweizen Nov 22, 2017

numeralnathan Feb 6, 2018

sylvainlaurent Nov 21, 2017

sylvainlaurent Nov 21, 2017

sylvainlaurent Nov 21, 2017

vorburger commented Nov 23, 2017

vorburger commented Mar 23, 2020

vorburger commented Mar 23, 2020

J-N-K commented Mar 4, 2021

#48 ZIP file to PR, java runtime library #56

#48 ZIP file to PR, java runtime library #56

Conversation

Bananeweizen commented Nov 11, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bananeweizen commented Nov 13, 2017

vorburger left a comment

Choose a reason for hiding this comment

maggu2810 commented Nov 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bananeweizen Nov 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vorburger commented Nov 23, 2017

vorburger commented Mar 23, 2020

vorburger commented Mar 23, 2020

J-N-K commented Mar 4, 2021

Bananeweizen commented Nov 11, 2017 •

edited

Loading

Bananeweizen Nov 22, 2017 •

edited

Loading