finalize milestone5 edit and readme

Author: wsw-stack

README-M5.md

@@ -0,0 +1,17 @@
+# Milestone 5 – Async support for **JSONObject**
+
+## What is Added
+
+| Item                                                                                                             | Description                                                                                                                                                                                                                                                       |
+|------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `Future<JSONObject> XMLUtils.toJSONObject(Reader reader, Consumer<JSONObject> after, Consumer<Exception> error)` | **Non-blocking** conversion. Parses the XML read from `reader` into a `JSONObject` on a background thread. When parsing finishes it invokes `after.accept(result)`; when failure it calls `error.accept(ex)` and throws the exception into the returned `Future`. |
+| `AsyncRunner`                                                                                                    | Tiny task aggregator. Call `add(Future<JSONObject> task)` to collect jobs, then wait for them all (e.g. `forEach(Future::get)`).                                                                                                                                  |
+| `ExecutorService`                                                                              | The default thread pool (size = available CPU cores). If you prefer a custom pool you can swap it out before calling the API (e.g. add `XMLUtils.setExecutor(...)`).                                                                                              |
+
+Input: XML of different sizes (where they will be parsed concurrently)
+
+---
+
+## Run the test class
+```bash
+mvn -Dtest=org.json.junit.milestone5.tests.JSONObjectAsyncTest test

src/main/java/org/json/XML.java

@@ -2240,76 +2240,10 @@ private static final String indent(int indent) {
         return sb.toString();
     }
 
-//    public static class asyncRunner {
-//        private List<Future<JSONObject>> tasks;
-//        private boolean running;
-//
-//        public asyncRunner() {
-//            this.tasks = new ArrayList<>();
-//            running = false;
-//        }
-//
-//        public void add(Future<JSONObject> task) {
-//            this.tasks.add(task);
-//        }
-//
-//
-//        public void run() {
-//            running = true;
-//            while(running) {
-//                List<Future<JSONObject>> nextTasks = new ArrayList<>();
-//                for(Future<JSONObject> task: tasks) {
-//                    if(!task.isDone()) {
-//                        nextTasks.add(task);
-//                    }
-//                }
-//                running = !nextTasks.isEmpty();
-//                tasks = nextTasks;
-//            }
-//        }
-//    }
-//
-//    public static Future<JSONObject> toJSONObject(Reader reader, Consumer<JSONObject> after, Consumer<Exception> error){
-//
-//        ExecutorService executor = Executors.newSingleThreadExecutor();
-//        futureTask task = new futureTask(reader, after, error);
-//        Future<JSONObject> future = executor.submit(task);
-//
-//        return future;
-//    }
-//
-//    private static class futureTask implements Callable<JSONObject> {
-//
-//        Reader reader;
-//        Consumer<JSONObject> after;
-//        Consumer<Exception> error;
-//        public futureTask(Reader reader, Consumer<JSONObject> after, Consumer<Exception> error) {
-//            this.reader = reader;
-//            this.after = after;
-//            this.error = error;
-//        }
-//
-//        @Override
-//        public JSONObject call() throws Exception {
-//            JSONObject jo = new JSONObject();
-//            try {
-//                XMLTokener x = new XMLTokener(reader);
-//                while (x.more()) {
-//                    x.skipPast("<");
-//                    if (x.more()) {
-//                        parse(x, jo, null, XMLParserConfiguration.ORIGINAL, 0);
-//                    }
-//                }
-//                after.accept(jo);
-//            } catch (Exception e) {
-//                error.accept(e);
-//            }
-//            return jo;
-//        }
-//    }
-private static final ExecutorService executor = Executors.newFixedThreadPool(
-        Runtime.getRuntime().availableProcessors()
-);
+    // milestone 5
+    private static final ExecutorService executor = Executors.newFixedThreadPool(
+            Runtime.getRuntime().availableProcessors()
+    );
 
     public static Future<JSONObject> toJSONObject(
             Reader reader,
@@ -2321,10 +2255,6 @@ public static Future<JSONObject> toJSONObject(
         return task;
     }
 
-    public static void shutdownExecutor() {
-        executor.shutdown();
-    }
-
     private static class FutureTaskCallable implements Callable<JSONObject> {
         private final Reader reader;
         private final Consumer<JSONObject> after;
@@ -2370,27 +2300,5 @@ public void add(Future<JSONObject> task) {
             this.tasks.add(task);
         }
 
-        public void run() {
-            boolean running = true;
-            while (running) {
-                List<Future<JSONObject>> nextTasks = new ArrayList<>();
-                for (Future<JSONObject> task : tasks) {
-                    if (!task.isDone()) {
-                        nextTasks.add(task);
-                    }
-                }
-                if (nextTasks.isEmpty()) {
-                    running = false;
-                } else {
-                    tasks = nextTasks;
-                    try {
-                        Thread.sleep(50);
-                    } catch (InterruptedException ie) {
-                        Thread.currentThread().interrupt();
-                        running = false;
-                    }
-                }
-            }
-        }
     }
 }