javax.json.stream.package-info Maven / Gradle / Ivy
Show all versions of javax.json-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
/**
* Provides a streaming API to parse and generate
* JSON.
*
*
* The streaming API consists of the interfaces
* {@link javax.json.stream.JsonParser} and
* {@link javax.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.
*
*
* {@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.
*
*
* {@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.
*
*
* 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 javax.json.stream;