api/src/main/java/jakarta/json/stream/package-info.java

/*
 * Copyright (c) 2012, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

/**
 * Provides a streaming API to parse and generate
 * <a href="http://json.org/">JSON</a>.
 *
 * <p>
 * The streaming API consists of the interfaces
 * {@link jakarta.json.stream.JsonParser} and
 * {@link jakarta.json.stream.JsonGenerator}. The interface {@code JsonParser}
 * contains methods to parse JSON in a streaming way. The interface
 * {@code JsonGenerator} contains methods to write JSON to an output source
 * in a streaming way.
 *
 * <p>
 * {@code JsonParser} provides forward, read-only access to JSON data using the
 * pull parsing programming model. In this model the application code controls
 * the thread and calls methods in the parser interface to move the parser
 * forward or to obtain JSON data from the current state of the parser.
 *
 * <p>
 * {@code JsonGenerator} provides methods to write JSON to an output source.
 * The generator writes name/value pairs in JSON objects and values in JSON
 * arrays.
 * 
 * <p>
 * The streaming API is a low-level API designed to process large amounts of
 * JSON data efficiently. Other JSON frameworks (such as JSON binding) can be
 * implemented using this API.
 *
 * @since JSON Processing 1.0
 */
package jakarta.json.stream;