source: josm/trunk/src/javax/json/JsonWriterFactory.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.6 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.OutputStream;
44import java.io.Writer;
45import java.nio.charset.Charset;
46import java.util.Map;
47
48/**
49 * Factory to create {@link javax.json.JsonWriter} instances. If a factory
50 * instance is configured with some configuration, that would be
51 * used to configure the created writer instances.
52 *
53 * <p>
54 * {@link javax.json.JsonWriter} can also be created using {@link Json}'s
55 * {@code createWriter} methods. If multiple writer instances are created,
56 * then creating them using a writer factory is preferred.
57 *
58 * <p>
59 * <b>For example:</b>
60 * <pre>
61 * <code>
62 * JsonWriterFactory factory = Json.createWriterFactory(...);
63 * JsonWriter writer1 = factory.createWriter(...);
64 * JsonWriter writer2 = factory.createWriter(...);
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 JsonWriterFactory {
72
73 /**
74 * Creates a JSON writer to write a JSON {@link JsonObject object} or
75 * {@link JsonArray array} structure to the specified character stream.
76 * The writer is configured with the factory configuration.
77 *
78 * @param writer to which JSON object or array is written
79 * @return a JSON writer
80 */
81 JsonWriter createWriter(Writer writer);
82
83 /**
84 * Creates a JSON writer to write a JSON {@link JsonObject object} or
85 * {@link JsonArray array} structure to the specified byte stream.
86 * Characters written to the stream are encoded into bytes using UTF-8
87 * encoding. The writer is configured with the factory configuration.
88 *
89 * @param out to which JSON object or array is written
90 * @return a JSON writer
91 */
92 JsonWriter createWriter(OutputStream out);
93
94 /**
95 * Creates a JSON writer to write a JSON {@link JsonObject object} or
96 * {@link JsonArray array} structure to the specified byte stream.
97 * Characters written to the stream are encoded into bytes using the
98 * specified charset. The writer is configured with the factory
99 * configuration.
100 *
101 * @param out to which JSON object or array is written
102 * @param charset a charset
103 * @return a JSON writer
104 */
105 JsonWriter createWriter(OutputStream out, Charset charset);
106
107 /**
108 * Returns read-only map of supported provider specific configuration
109 * properties that are used to configure the created JSON writer objects.
110 * If there are any specified configuration properties that are not
111 * supported by the provider, they won't be part of the returned map.
112 *
113 * @return a map of supported provider specific properties that are used
114 * to configure the created writers. The map may be empty but not null.
115 */
116 Map<String, ?> getConfigInUse();
117
118}
Note: See TracBrowser for help on using the repository browser.