source: josm/trunk/src/javax/json/JsonReaderFactory.java@ 13611

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

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

File size: 4.3 KB
Line 
1/*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 2013-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
41package javax.json;
42
43import java.io.InputStream;
44import java.io.Reader;
45import java.nio.charset.Charset;
46import java.util.Map;
47
48/**
49 * Factory to create {@link javax.json.JsonReader} instances. If a factory
50 * instance is configured with some configuration, that would be
51 * used to configure the created reader instances.
52 *
53 * <p>
54 * {@link javax.json.JsonReader} can also be created using {@link Json}'s
55 * {@code createReader} methods. If multiple reader instances are created,
56 * then creating them using a reader factory is preferred.
57 *
58 * <p>
59 * <b>For example:</b>
60 * <pre>
61 * <code>
62 * JsonReaderFactory factory = Json.createReaderFactory(...);
63 * JsonReader reader1 = factory.createReader(...);
64 * JsonReader reader2 = factory.createReader(...);
65 * </code>
66 * </pre>
67 *
68 * <p> All the methods in this class are safe for use by multiple concurrent
69 * threads.
70 */
71public interface JsonReaderFactory {
72
73 /**
74 * Creates a JSON reader from a character stream. The reader is configured
75 * with the factory configuration.
76 *
77 * @param reader a reader from which JSON is to be read
78 * @return a JSON reader
79 */
80 JsonReader createReader(Reader reader);
81
82 /**
83 * Creates a JSON reader from a byte stream. The character encoding of
84 * the stream is determined as described in
85 * <a href="http://tools.ietf.org/rfc/rfc7159.txt">RFC 7159</a>.
86 * The reader is configured with the factory configuration.
87 *
88 * @param in a byte stream from which JSON is to be read
89 * @return a JSON reader
90 */
91 JsonReader createReader(InputStream in);
92
93 /**
94 * Creates a JSON reader from a byte stream. The bytes of the stream
95 * are decoded to characters using the specified charset. The reader is
96 * configured with the factory configuration.
97 *
98 * @param in a byte stream from which JSON is to be read
99 * @param charset a charset
100 * @return a JSON reader
101 */
102 JsonReader createReader(InputStream in, Charset charset);
103
104 /**
105 * Returns read-only map of supported provider specific configuration
106 * properties that are used to configure the created JSON readers.
107 * If there are any specified configuration properties that are not
108 * supported by the provider, they won't be part of the returned map.
109 *
110 * @return a map of supported provider specific properties that are used
111 * to configure the readers. The map be empty but not null.
112 */
113 Map<String, ?> getConfigInUse();
114
115}
Note: See TracBrowser for help on using the repository browser.