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.Objects;
29 
30 /**
31  * The interface that represents JSON string.
32  * <p>
33  * A {@code JsonString} can be produced by a {@link Json#parse(String)}.
34  * <p> Alternatively, {@link #of(String)} can be used to obtain a {@code JsonString}
35  * from a {@code String}.
36  *
37  */
38 public sealed interface JsonString extends JsonValue permits JsonStringImpl {
39 
40     /**
41      * {@return the {@code String} value represented by this
42      * {@code JsonString} value} This value is an unescaped version of the
43      * underlying {@code String} value. For example,
44      * {@snippet lang=java:
45      *     JsonString.of("fo\\u006f").value(); // returns "foo"
46      * }
47      */
48     String value();
49 
50     /**
51      * {@return the {@code JsonString} created from the given
52      * {@code String}}
53      *
54      * @param src the given {@code String}. Non-null.
55      */
56     static JsonString of(String src) {
57         Objects.requireNonNull(src);
58         return new JsonStringImpl(src);
59     }
60 }