source: josm/trunk/src/javax/json/stream/package-info.java@ 13777

Last change on this file since 13777 was 13231, checked in by Don-vip, 7 years ago

see #15682 - upgrade to JSR 374 (JSON Processing) API 1.1.2

File size: 3.1 KB
Line 
1/*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can
10 * obtain a copy of the License at
11 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
12 * or LICENSE.txt. See the License for the specific
13 * language governing permissions and limitations under the License.
14 *
15 * When distributing the software, include this License Header Notice in each
16 * file and include the License file at LICENSE.txt.
17 *
18 * GPL Classpath Exception:
19 * Oracle designates this particular file as subject to the "Classpath"
20 * exception as provided by Oracle in the GPL Version 2 section of the License
21 * file that accompanied this code.
22 *
23 * Modifications:
24 * If applicable, add the following below the License Header, with the fields
25 * enclosed by brackets [] replaced by your own identifying information:
26 * "Portions Copyright [year] [name of copyright owner]"
27 *
28 * Contributor(s):
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41/**
42 * Provides a streaming API to parse and generate
43 * <a href="http://json.org/">JSON</a>.
44 *
45 * <p>
46 * The streaming API consists of the interfaces
47 * {@link javax.json.stream.JsonParser} and
48 * {@link javax.json.stream.JsonGenerator}. The interface {@code JsonParser}
49 * contains methods to parse JSON in a streaming way. The interface
50 * {@code JsonGenerator} contains methods to write JSON to an output source
51 * in a streaming way.
52 *
53 * <p>
54 * {@code JsonParser} provides forward, read-only access to JSON data using the
55 * pull parsing programming model. In this model the application code controls
56 * the thread and calls methods in the parser interface to move the parser
57 * forward or to obtain JSON data from the current state of the parser.
58 *
59 * <p>
60 * {@code JsonGenerator} provides methods to write JSON to an output source.
61 * The generator writes name/value pairs in JSON objects and values in JSON
62 * arrays.
63 *
64 * <p>
65 * The streaming API is a low-level API designed to process large amounts of
66 * JSON data efficiently. Other JSON frameworks (such as JSON binding) can be
67 * implemented using this API.
68 *
69 * @since JSON Processing 1.0
70 */
71package javax.json.stream;
Note: See TracBrowser for help on using the repository browser.