1 /*
 2  * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
 3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 4  *
 5  * This code is free software; you can redistribute it and/or modify it
 6  * under the terms of the GNU General Public License version 2 only, as
 7  * published by the Free Software Foundation.  Oracle designates this
 8  * particular file as subject to the "Classpath" exception as provided
 9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package oracle.code.json;
27 
28 import java.util.Map;
29 import java.util.Objects;
30 
31 /**
32  * The interface that represents JSON object.
33  * <p>
34  * A {@code JsonObject} can be produced by a {@link Json#parse(String)}.
35  * <p> Alternatively, {@link #of(Map)} can be used to obtain a {@code JsonObject}.
36  * Since {@code JsonObject} is backed by {@link Map}, duplicate keys
37  * may not be allowed. If duplicate keys appear during a {@link Json#parse(String)},
38  * a {@code JsonParseException} is thrown.
39  *
40  */
41 public sealed interface JsonObject extends JsonValue permits JsonObjectImpl {
42 
43     /**
44      * {@return the map of {@code String} to {@code JsonValue} members in this
45      * JSON object}
46      */
47     Map<String, JsonValue> keys();
48 
49     /**
50      * {@return the {@code JsonObject} created from the given
51      * map of {@code String} to {@code JsonValue}s}
52      *
53      * @param map the map of {@code JsonValue}s. Non-null.
54      * @throws IllegalArgumentException if the conversion of {@code map} to a
55      * {@code JsonObject} exceeds a nest limit.
56      */
57     static JsonObject of(Map<String, ? extends JsonValue> map) {
58         var jo = new JsonObjectImpl(Objects.requireNonNull(map));
59         JsonGenerator.checkDepth(jo, 1);
60         return jo;
61     }
62 }