Skip to content

(JSONArray).toList() breaks format of entries  #737

Open

Description

@JulWas797

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}

Activity

  1. changed the title [-](JSONArray).toList() corrupts entries [/-] [+](JSONArray).toList() breaks format of entries [/+] on May 20, 2023
  2. JulWas797 commented on May 20, 2023

    @JulWas797
    Author

    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.

  3. stleary commented on May 20, 2023

    @stleary
    Owner

    @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?

  4. JulWas797 commented on May 20, 2023

    @JulWas797
    Author

    @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).

  5. stleary commented on Sep 4, 2023

    @stleary
    Owner

    Streams support proposed implementation: #768

  6. aryanttripathi commented on Oct 8, 2023

    @aryanttripathi

    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 :)

  7. ZachsCoffee commented on Oct 8, 2023

    @ZachsCoffee

    @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)

  8. Priyanshu-ai902 commented on Oct 16, 2023

    @Priyanshu-ai902

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

  9. stleary commented on Oct 16, 2023

    @stleary
    Owner

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

  10. ZachsCoffee commented on Oct 22, 2023

    @ZachsCoffee

    @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);
  11. stleary commented on Oct 22, 2023

    @stleary
    Owner

    @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.

  12. stleary commented on Sep 20, 2025

    @stleary
    Owner

    Comment from @aghasemi in #1012
    It's obviously deliberate and the desired behaviour, and the reason is very likely somewhere documented, but unfortunately I could not find it. So may I ask what is the logic or use cases for this behaviour?

    And will you consider a new method to return a list of objects without converting JSONObjects to Maps etc?

    Thanks
    Best

  13. johnjaylward commented on Sep 22, 2025

    @johnjaylward
    Contributor

    Just to make a note here: The proper way to use the Streams API on an object that exposes an iterator, but not a stream directly is to use the StreamSupport and Spliterators helper classes to make a Spliterator from the iterator, which you can them stream.

    StreamSupport.stream(
                Spliterators.spliteratorUnknownSize(myJavaArray.Iterator(), 0), 
                false
    );
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions