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

(JSONArray).toList() breaks format of entries

Open JulWas797 opened this issue 2 years ago • 10 comments

Unfortunately invoking method .toList() on JSONArray Object causes entries of the JSONArray to become malformated.

Issue examples:

Output from (JSONArray).get() {"data":{"pressure_avg":1012.3399999999999,"humidity_avg":61.5,"temperature_avg":12.85,"pm10_avg":0.6900000000000001,"pm25_avg":0.36},"school":{"city":"DŁUGOŁĘKA","street":null,"post_code":"19-111","latitude":"53.2753471","name":"SZKOŁA PODSTAWOWA W DŁUGOŁĘCE","longitude":"22.8683732"},"timestamp":"2023-05-19 23:56:45"}

Output from (JSONArray).toList().get() {data={pressure_avg=1012.3399999999999, humidity_avg=61.5, temperature_avg=12.85, pm10_avg=0.6900000000000001, pm25_avg=0.36}, school={city=DŁUGOŁĘKA, street=null, post_code=19-111, latitude=53.2753471, name=SZKOŁA PODSTAWOWA W DŁUGOŁĘCE, longitude=22.8683732}, timestamp=2023-05-19 23:56:45}

JulWas797 avatar May 19 '23 22:05 JulWas797

I decided to change the title, as it's late for me and i made mistake in it.

According to your javadocs, this is not a desired behavior.

JulWas797 avatar May 20 '23 00:05 JulWas797

@JulWas797 JSONArray.toString() will output a JSON doc, if that is what you want. We cannot change toList() due to backwards compatibility. Can you describe what you are trying to do?

stleary avatar May 20 '23 00:05 stleary

@JulWas797 JSONArray.toString() will output a JSON doc, if that is what you want. We cannot change toList() due to backwards compatibility. Can you describe what you are trying to do?

Thanks for responding!

What I'm trying to basically acheive is to access elements of JSONArray using Streams API, and using .toList() is the only option to do so.

As JSONArray already has Iterator, i would propose to integrate Streams directly in it (I will also check what I can do, and maybe try to make PR with this).

JulWas797 avatar May 20 '23 09:05 JulWas797

Streams support proposed implementation: #768

stleary avatar Sep 04 '23 18:09 stleary

Sir @stleary , What will be the expected result we want? I just started putting my steps in the open-source community. I will be glad if I can help :)

Aryant-Tripathi avatar Oct 08 '23 08:10 Aryant-Tripathi

@stleary I can propose a solution for this: I can make the org.json.JSONArray to implement the java.util.List interface and not the Iterable directly. This way, it will have the stream() method also all the functionality that a List should have. Because as I see from the class code it behaves like a List but with some minor changes. (I have these changes ready for PR)

ZachsCoffee avatar Oct 08 '23 14:10 ZachsCoffee

Hi @stleary i am interested in this issue Will you assign me this issue to work on it

Priyanshu-ai902 avatar Oct 16 '23 17:10 Priyanshu-ai902

@Priyanshu-ai902 This project does not assign issues. Feel free to work on any issue that interests you.

stleary avatar Oct 16 '23 17:10 stleary

@stleary So if we can't use (for now at least) the Java 8 features we can't make the JSONArray return a Stream. The problem from the issue description is that when the toList() is called, it will translate all the JSONObject to HasMap and the HasMap class has the toString() method to print the map to this format.

{data={pressure_avg=1012.3399999999999, humidity_avg=61.5, temperature_avg=12.85, pm10_avg=0.6900000000000001, pm25_avg=0.36}, school={city=DŁUGOŁĘKA, street=null, post_code=19-111, latitude=53.2753471, name=SZKOŁA PODSTAWOWA W DŁUGOŁĘCE, longitude=22.8683732}, timestamp=2023-05-19 23:56:45}

@JulWas797 As I see, the only way to iterate the "real" data inside the JSONArray is from the Iterator. To make an Iterable to Stream you can do the following:

JSONArray jArray = ...;
Iterable<Object> iterable = () -> jArray.iterator();
Stream<Object> stream = StreamSupport.stream(iterable.spliterator(), false);

ZachsCoffee avatar Oct 22 '23 12:10 ZachsCoffee

@ZachsCoffee It was probably not a great idea to include JSONArray.toList() in the project in the first place. The best thing to do now may be to mark it as @deprecated with a comment explaining how someone might get the desired functionality by coding an external method with the streaming API. You can add a getAsList(), optList(), or a similar method if you can think of a valid use case and code it in a way that does not require Java 8.

stleary avatar Oct 22 '23 21:10 stleary