36 | * Supported values are: 37 | *
28101633 | * You can create a Json5 instance by invoking {@link #Json5(Json5Options)} 34 | * or by using {@link #builder(Function)}. 35 | *
36 | * 37 | *38 | * This class contains several utility methods to parse and serialize json5 data by passing 39 | * {@link Reader}, {@link Writer} or simple {@link String} instances. 40 | *
41 | * 42 | *
43 | * {@code
44 | * // Create Json5 instance using builder pattern to configure desired options
45 | * Json5 json5 = Json5.builder(builder -> builder
46 | * .quoteless()
47 | * .quoteSingle()
48 | * .parseComments()
49 | * .writeComments()
50 | * .prettyPrinting()
51 | * .build()
52 | * );
53 | *
54 | * // Parse from a String
55 | * Json5Element element =
56 | * json5.parse("{ 'key': 'value', 'array': ['first val','second val'] }");
57 | *
58 | * // Or parse from a Reader or InputStream
59 | * try (InputStream stream = ...) {
60 | * Json5Element element = json5.parse(stream);
61 | * // ...
62 | * } catch (IOException e) {
63 | * // ...
64 | * }
65 | *
66 | * // Serialize to a String
67 | * String json5String = json5.serialize(element);
68 | *
69 | * // Serialize to a Writer or OutputStream
70 | * try (OutputStream stream = ...) {
71 | * json5.serialize(element, stream);
72 | * // ...
73 | * } catch (IOException e) {
74 | * // ...
75 | * }
76 | *
77 | * }
78 | *
79 | *
80 | * @author Marcel Haßlinger
81 | * @see Json5 Specification
82 | * @see Json5Parser
83 | * @see Json5Writer
84 | */
85 | public final class Json5 {
86 |
87 | /**
88 | * Constructs a new json5 instance by using the {@link Json5Options#builder()}.
89 | *
90 | * @param builder Options builder
91 | * @return Built options
92 | */
93 | public static Json5 builder(FunctionNote: The stream must be closed after operation
121 | * 122 | * @param in Can be any applicable {@link InputStream} 123 | * @return Parsed json5 tree. Can be {@code null} if the provided stream does not contain any data 124 | * @see #parse(Reader) 125 | */ 126 | public Json5Element parse(InputStream in) { 127 | Objects.requireNonNull(in); 128 | return parse(new InputStreamReader(in)); 129 | } 130 | 131 | /** 132 | * Parses the provided read-stream into a tree of {@link Json5Element}'s. 133 | *Note: The reader must be closed after operation
134 | * 135 | * @param reader Can be any applicable {@link Reader} 136 | * @return Parsed json5 tree. Can be {@code null} if the provided stream does not contain any data 137 | * @see Json5Parser#parse(Json5Lexer) 138 | */ 139 | public Json5Element parse(Reader reader) { 140 | Objects.requireNonNull(reader); 141 | 142 | Json5Lexer lexer = new Json5Lexer(reader, this.options); 143 | return Json5Parser.parse(lexer); 144 | } 145 | 146 | /** 147 | * Parses the provided json5-encoded {@link String} into a parse tree of {@link Json5Element}'s. 148 | * 149 | * @param string Json5 encoded {@link String} 150 | * @return Parsed json5 tree. Can be {@code null} if the provided {@link String} is empty 151 | * @see #parse(Reader) 152 | */ 153 | public Json5Element parse(String string) { 154 | Objects.requireNonNull(string); 155 | 156 | StringReader reader = new StringReader(string); 157 | Json5Element element = this.parse(reader); 158 | reader.close(); 159 | return element; 160 | } 161 | 162 | /** 163 | * Encodes the provided element into its character literal representation by using an output-stream. 164 | *Note: The stream must be closed after operation ({@link OutputStream#close()})!
165 | * 166 | * @param element {@link Json5Element} to serialize 167 | * @param out Can be any applicable {@link OutputStream} 168 | * @throws IOException If an I/O error occurs 169 | * @see #serialize(Json5Element, Writer) 170 | */ 171 | public void serialize(Json5Element element, OutputStream out) throws IOException { 172 | Objects.requireNonNull(element); 173 | Objects.requireNonNull(out); 174 | 175 | serialize(element, new OutputStreamWriter(out)); 176 | } 177 | 178 | /** 179 | * Encodes the provided element into its character literal representation by using a write-stream. 180 | *Note: The writer must be closed after operation ({@link Writer#close()})!
181 | * 182 | * @param element {@link Json5Element} to serialize 183 | * @param writer Can be any applicable {@link Writer} 184 | * @throws IOException If an I/O error occurs 185 | * @see Json5Writer#write(Json5Element) 186 | */ 187 | public void serialize(Json5Element element, Writer writer) throws IOException { 188 | Objects.requireNonNull(element); 189 | Objects.requireNonNull(writer); 190 | 191 | Json5Writer json5Writer = new Json5Writer(this.options, writer); 192 | json5Writer.write(element); 193 | } 194 | 195 | /** 196 | * Encodes the provided element into its character literal representation. 197 | * 198 | * @param element {@link Json5Element} to serialize 199 | * @return Json5 encoded {@link String} 200 | * @throws IOException If an I/O error occurs 201 | * @see #serialize(Json5Element, Writer) 202 | */ 203 | public String serialize(Json5Element element) throws IOException { 204 | Objects.requireNonNull(element); 205 | 206 | StringWriter writer = new StringWriter(); 207 | serialize(element, writer); 208 | writer.close(); 209 | return writer.toString(); 210 | } 211 | } 212 | -------------------------------------------------------------------------------- /src/test/java/de/marhali/json5/e2e/roundtrips/ParserAndWriterTest.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2025 Marcel Haßlinger 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package de.marhali.json5.e2e.roundtrips; 18 | 19 | import de.marhali.json5.Json5; 20 | import de.marhali.json5.e2e.TestResourceHelper; 21 | import de.marhali.json5.fixtures.Json5OptionsFixtures; 22 | import org.junit.jupiter.api.Test; 23 | 24 | import java.io.IOException; 25 | 26 | import static org.junit.jupiter.api.Assertions.*; 27 | 28 | /** 29 | * @author Marcel Haßlinger 30 | */ 31 | public class ParserAndWriterTest { 32 | @Test 33 | void objectRoundtrip() throws IOException { 34 | var json5 = new Json5(Json5OptionsFixtures.PRETTY); 35 | 36 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/object.parser.json5")); 37 | var stringifiedElement = json5.serialize(element); 38 | 39 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/object.writer.json5"); 40 | 41 | assertEquals(expectedStringifiedElement, stringifiedElement); 42 | } 43 | 44 | @Test 45 | void objectRoundtripNoComment() throws IOException { 46 | var json5 = new Json5(Json5OptionsFixtures.PRETTY_NO_COMMENTS); 47 | 48 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/object.parser.json5")); 49 | var stringifiedElement = json5.serialize(element); 50 | 51 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/object-no-comment.writer.json5"); 52 | 53 | assertEquals(expectedStringifiedElement, stringifiedElement); 54 | } 55 | 56 | @Test 57 | void objectRoundtripMinifyNoComment() throws IOException { 58 | var json5 = new Json5(Json5OptionsFixtures.MINIFY_NO_COMMENTS); 59 | 60 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/object.parser.json5")); 61 | var stringifiedElement = json5.serialize(element); 62 | 63 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/object-minify-no-comment.writer.json5"); 64 | 65 | assertEquals(expectedStringifiedElement, stringifiedElement); 66 | } 67 | 68 | @Test 69 | void objectRoundtripMinify() throws IOException { 70 | var json5 = new Json5(Json5OptionsFixtures.MINIFY); 71 | 72 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/object.parser.json5")); 73 | var stringifiedElement = json5.serialize(element); 74 | 75 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/object-minify.writer.json5"); 76 | 77 | assertEquals(expectedStringifiedElement, stringifiedElement); 78 | } 79 | 80 | @Test 81 | void objectRoundtripMinifyToPretty() throws IOException { 82 | var json5 = new Json5(Json5OptionsFixtures.PRETTY); 83 | 84 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/object-minify.parser.json5")); 85 | var stringifiedElement = json5.serialize(element); 86 | 87 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/object-minify-to-prettify.writer.json5"); 88 | 89 | assertEquals(expectedStringifiedElement, stringifiedElement); 90 | } 91 | 92 | @Test 93 | void arrayRoundtrip() throws IOException { 94 | var json5 = new Json5(Json5OptionsFixtures.PRETTY); 95 | 96 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/array.parser.json5")); 97 | var stringifiedElement = json5.serialize(element); 98 | 99 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/array.writer.json5"); 100 | 101 | assertEquals(expectedStringifiedElement, stringifiedElement); 102 | } 103 | 104 | @Test 105 | void arrayRoundtripNoComment() throws IOException { 106 | var json5 = new Json5(Json5OptionsFixtures.PRETTY_NO_COMMENTS); 107 | 108 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/array.parser.json5")); 109 | var stringifiedElement = json5.serialize(element); 110 | 111 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/array-no-comment.writer.json5"); 112 | 113 | assertEquals(expectedStringifiedElement, stringifiedElement); 114 | } 115 | 116 | @Test 117 | void arrayRoundtripMinifyNoComment() throws IOException { 118 | var json5 = new Json5(Json5OptionsFixtures.MINIFY_NO_COMMENTS); 119 | 120 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/array.parser.json5")); 121 | var stringifiedElement = json5.serialize(element); 122 | 123 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/array-minify-no-comment.writer.json5"); 124 | 125 | assertEquals(expectedStringifiedElement, stringifiedElement); 126 | } 127 | 128 | @Test 129 | void arrayRoundtripMinify() throws IOException { 130 | var json5 = new Json5(Json5OptionsFixtures.MINIFY); 131 | 132 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/array.parser.json5")); 133 | var stringifiedElement = json5.serialize(element); 134 | 135 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/array-minify.writer.json5"); 136 | 137 | assertEquals(expectedStringifiedElement, stringifiedElement); 138 | } 139 | 140 | @Test 141 | void arrayRoundtripMinifyToPretty() throws IOException { 142 | var json5 = new Json5(Json5OptionsFixtures.PRETTY); 143 | 144 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/array-minify.parser.json5")); 145 | var stringifiedElement = json5.serialize(element); 146 | 147 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/array-minify-to-prettify.writer.json5"); 148 | 149 | assertEquals(expectedStringifiedElement, stringifiedElement); 150 | } 151 | 152 | @Test 153 | void extensionsRoundtripCStyle() throws IOException { 154 | var json5 = new Json5(Json5OptionsFixtures.EXTENSIONS_C_STYLE); 155 | 156 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/extensions-c-style.parser.json5")); 157 | var stringifiedElement = json5.serialize(element); 158 | 159 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/extensions-c-style.writer.json5"); 160 | 161 | assertEquals(expectedStringifiedElement, stringifiedElement); 162 | } 163 | 164 | @Test 165 | void extensionsRoundtripJavaStyle() throws IOException { 166 | var json5 = new Json5(Json5OptionsFixtures.EXTENSIONS_JAVA_STYLE); 167 | 168 | var element = json5.parse(TestResourceHelper.getTestResource("e2e/roundtrips/extensions-java-style.parser.json5")); 169 | var stringifiedElement = json5.serialize(element); 170 | 171 | var expectedStringifiedElement = TestResourceHelper.getTestResourceContent("e2e/roundtrips/extensions-java-style.writer.json5"); 172 | 173 | assertEquals(expectedStringifiedElement, stringifiedElement); 174 | } 175 | } 176 | -------------------------------------------------------------------------------- /src/main/java/de/marhali/json5/stream/Json5Parser.java: -------------------------------------------------------------------------------- 1 | /* 2 | * MIT License 3 | * 4 | * Copyright (C) 2021 SyntaxError404 5 | * Copyright (C) 2022 Marcel Haßlinger 6 | * 7 | * Permission is hereby granted, free of charge, to any person obtaining a copy 8 | * of this software and associated documentation files (the "Software"), to deal 9 | * in the Software without restriction, including without limitation the rights 10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 | * copies of the Software, and to permit persons to whom the Software is 12 | * furnished to do so, subject to the following conditions: 13 | * 14 | * The above copyright notice and this permission notice shall be included in all 15 | * copies or substantial portions of the Software. 16 | * 17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 | * SOFTWARE. 24 | */ 25 | 26 | package de.marhali.json5.stream; 27 | 28 | import de.marhali.json5.Json5Array; 29 | import de.marhali.json5.Json5Element; 30 | import de.marhali.json5.Json5Object; 31 | import de.marhali.json5.config.DuplicateKeyStrategy; 32 | import de.marhali.json5.exception.Json5Exception; 33 | 34 | import java.util.HashSet; 35 | import java.util.Objects; 36 | import java.util.Set; 37 | 38 | /** 39 | * A parser to parse tokenized Json5 data into a parse tree of {@link Json5Element}'s. 40 | * 41 | * @author Marcel Haßlinger 42 | * @author SyntaxError404 43 | */ 44 | public final class Json5Parser { 45 | 46 | private Json5Parser() { 47 | } 48 | 49 | /** 50 | * Parses the specified {@link Json5Lexer lexer} into a parse tree of {@link Json5Element}'s. 51 | * Thereby it does not matter if the provided root element is an array or object. 52 | * 53 | * @param lexer Tokenized json5 data 54 | * @return a parse tree of {@link Json5Element}'s corresponding to the specified JSON5 or {@code null} if lexer does not provide any data 55 | */ 56 | public static Json5Element parse(Json5Lexer lexer) { 57 | Objects.requireNonNull(lexer); 58 | 59 | char control = lexer.nextClean(); 60 | String comment = lexer.consumeComment(); 61 | Json5Element element; 62 | 63 | switch (control) { 64 | case '{': 65 | lexer.back(); 66 | element = parseObject(lexer); 67 | break; 68 | case '[': 69 | lexer.back(); 70 | element = parseArray(lexer); 71 | break; 72 | case 0: 73 | return null; 74 | default: 75 | throw lexer.syntaxError("Unknown or unexpected control character"); 76 | } 77 | 78 | if (lexer.options.isParseComments() && comment != null) { 79 | element.setComment(comment); 80 | } 81 | 82 | return element; 83 | } 84 | 85 | /** 86 | * Parses the specified {@link Json5Lexer lexer} into a parse tree of an {@link Json5Object}. 87 | * If the provided data does not correspond to a {@link Json5Object} a {@link Json5Exception} will be thrown. 88 | * 89 | * @param lexer Tokenized json5 data. 90 | * @return a parse tree of {@link Json5Object} corresponding to the specified JSON5. 91 | * @see #parse(Json5Lexer) 92 | */ 93 | public static Json5Object parseObject(Json5Lexer lexer) { 94 | Objects.requireNonNull(lexer); 95 | 96 | if (lexer.nextClean() != '{') { 97 | throw lexer.syntaxError("A Json5Object must begin with '{'"); 98 | } 99 | 100 | Json5Object object = new Json5Object(); 101 | 102 | DuplicateKeyStrategy duplicateKeyStrategy = lexer.options.getDuplicateBehaviour(); 103 | Set{@code Json5Object} does not implement the {@link Map} interface, but a {@code Map} view of it 35 | * can be obtained with {@link #asMap()}. 36 | * 37 | *
See the {@link Json5} documentation for details on how to convert {@code Json5Object} and
38 | * generally any {@code Json5Element} from and to Json5.
39 | *
40 | * @author Inderjeet Singh
41 | * @author Joel Leitch
42 | * @author Marcel Haßlinger
43 | */
44 | public final class Json5Object extends Json5Element {
45 | private final LinkedTreeMap The {@code Map} does not permit {@code null} keys or values. Unlike {@code Json5Object}'s
246 | * {@code null} handling, a {@link NullPointerException} is thrown when trying to add {@code
247 | * null}. Use {@link Json5Null} for Json5 null values.
248 | *
249 | * @return mutable {@code Map} view
250 | */
251 | public Map