JSON-java icon indicating copy to clipboard operation
JSON-java copied to clipboard

org.json.JSONTokener should close or provide option to close java.io.Reader

Open rikkarth opened this issue 1 year ago • 4 comments

Hi,

I spent a few days trying to fix an issue where I got the following error:

java.nio.file.FileSystemException: path/to/file: The process cannot access the file because it is being used by another process.

I started using FileLock to try to get a hold on the lock and wait until the lock was released, but unfortunately for this file, it would never be released.

That is because I was using a JSONTokener to tokenize a JSON file using an anonymous FileReader. This stream would never be closed, and therefor the error mentioned above.

image

Because JSONTokener doesn't provide an API to close the stream provided as parameter, I have to correct my implementation like this:

image

Obviously after reading the class it is clear how it should be used, since it is clearly written in the JavaDoc that the Reader must be closed by the caller.

image

I believe this implementation could be improved.

  • Implement Closeable/AutoClosable on JSONTokener and make JSONTokener throw some sort of exception to explicitly tell the user that the Reader must be closed. And then we could have a cleaner and more explicit implementation like this:

image

Let me know if my suggestion is outrageous. But I feel at least I should bring it here.

Thank you for your attention. :)

rikkarth avatar Dec 07 '23 10:12 rikkarth

@rikkarth Thanks for bringing this up. Unfortunately, at present, this project cannot accept Java 8 features like Closeable and AutoCloseable due to some Android developers being stuck on Java 7.

stleary avatar Dec 07 '23 14:12 stleary

@stleary , thank you for the quick reply.

Not sure if is worth to keep or archive this ticket for the future then. But thank you for your attention to this.

Thank you for the feedback and have a great day.

rikkarth avatar Dec 07 '23 15:12 rikkarth

hi, since new version supports Closeable and AutoCloseable, I'd like just to suggest that the JSONTokener to be reviewed if possible. Thank you for your service.

rikkarth avatar Jan 30 '24 23:01 rikkarth

Hi @rikkarth Sorry, that is still not an option at this time.

stleary avatar Feb 02 '24 18:02 stleary