source: josm/trunk/src/javax/json/JsonWriterFactory.java@ 6869

Last change on this file since 6869 was 6756, checked in by Don-vip, 11 years ago

fix #9590 - replace org.json with GPL-compliant jsonp + remove mention of old world image removed in r1680

File size: 4.8 KB
Line 
1/*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 2013 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://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
12 * or packager/legal/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 packager/legal/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 *
71 * @author Jitendra Kotamraju
72 */
73public interface JsonWriterFactory {
74
75 /**
76 * Creates a JSON writer to write a JSON {@link JsonObject object} or
77 * {@link JsonArray array} structure to the specified character stream.
78 * The writer is configured with the factory configuration.
79 *
80 * @param writer to which JSON object or array is written
81 * @return a JSON writer
82 */
83 JsonWriter createWriter(Writer writer);
84
85 /**
86 * Creates a JSON writer to write a JSON {@link JsonObject object} or
87 * {@link JsonArray array} structure to the specified byte stream.
88 * Characters written to the stream are encoded into bytes using UTF-8
89 * encoding. The writer is configured with the factory configuration.
90 *
91 * @param out to which JSON object or array is written
92 * @return a JSON writer
93 */
94 JsonWriter createWriter(OutputStream out);
95
96 /**
97 * Creates a JSON writer to write a JSON {@link JsonObject object} or
98 * {@link JsonArray array} structure to the specified byte stream.
99 * Characters written to the stream are encoded into bytes using the
100 * specified charset. The writer is configured with the factory
101 * configuration.
102 *
103 * @param out to which JSON object or array is written
104 * @param charset a charset
105 * @return a JSON writer
106 */
107 JsonWriter createWriter(OutputStream out, Charset charset);
108
109 /**
110 * Returns read-only map of supported provider specific configuration
111 * properties that are used to configure the created JSON writer objects.
112 * If there are any specified configuration properties that are not
113 * supported by the provider, they won't be part of the returned map.
114 *
115 * @return a map of supported provider specific properties that are used
116 * to configure the created writers. The map may be empty but not null.
117 */
118 Map<String, ?> getConfigInUse();
119
120}
Note: See TracBrowser for help on using the repository browser.