source: josm/trunk/src/javax/json/JsonBuilderFactory.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: 5.5 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.util.Collection;
44import java.util.Map;
45
46/**
47 * Factory to create {@link JsonObjectBuilder} and {@link JsonArrayBuilder}
48 * instances. If a factory instance is configured with some configuration,
49 * that would be used to configure the created builder instances.
50 *
51 * <p>
52 * {@code JsonObjectBuilder} and {@code JsonArrayBuilder} can also be created
53 * using {@link Json}'s methods. If multiple builder instances are created,
54 * then creating them using a builder factory is preferred.
55 *
56 * <p>
57 * <b>For example:</b>
58 * <pre>
59 * <code>
60 * JsonBuilderFactory factory = Json.createBuilderFactory(...);
61 * JsonArray value = factory.createArrayBuilder()
62 * .add(factory.createObjectBuilder()
63 * .add("type", "home")
64 * .add("number", "212 555-1234"))
65 * .add(factory.createObjectBuilder()
66 * .add("type", "fax")
67 * .add("number", "646 555-4567"))
68 * .build();
69 * </code>
70 * </pre>
71 *
72 * <p> All the methods in this class are safe for use by multiple concurrent
73 * threads.
74 */
75public interface JsonBuilderFactory {
76
77 /**
78 * Creates a {@code JsonObjectBuilder} instance that is used to build
79 * {@link JsonObject}.
80 *
81 * @return a JSON object builder
82 */
83 JsonObjectBuilder createObjectBuilder();
84
85 /**
86 * Creates a {@code JsonObjectBuilder} instance, initialized with an object.
87 *
88 * @param object the initial object in the builder
89 * @return a JSON object builder
90 * @throws NullPointerException if specified object is {@code null}
91 *
92 * @since 1.1
93 */
94 default JsonObjectBuilder createObjectBuilder(JsonObject object) {
95 throw new UnsupportedOperationException();
96 }
97
98 /**
99 * Creates a {@code JsonObjectBuilder} instance, initialized with the specified object.
100 *
101 * @param object the initial object in the builder
102 * @return a JSON object builder
103 * @throws NullPointerException if specified object is {@code null}
104 *
105 * @since 1.1
106 */
107 default JsonObjectBuilder createObjectBuilder(Map<String, Object> object) {
108 throw new UnsupportedOperationException();
109 }
110
111 /**
112 * Creates a {@code JsonArrayBuilder} instance that is used to build
113 * {@link JsonArray}
114 *
115 * @return a JSON array builder
116 */
117 JsonArrayBuilder createArrayBuilder();
118
119 /**
120 * Creates a {@code JsonArrayBuilder} instance, initialized with an array.
121 *
122 * @param array the initial array in the builder
123 * @return a JSON array builder
124 * @throws NullPointerException if specified array is {@code null}
125 *
126 * @since 1.1
127 */
128 default JsonArrayBuilder createArrayBuilder(JsonArray array) {
129 throw new UnsupportedOperationException();
130 }
131
132 /**
133 * Creates a {@code JsonArrayBuilder} instance,
134 * initialized with the content of specified collection.
135 *
136 * @param collection the initial data for the builder
137 * @return a JSON array builder
138 * @throws NullPointerException if specified collection is {@code null}
139 *
140 * @since 1.1
141 */
142 default JsonArrayBuilder createArrayBuilder(Collection<?> collection) {
143 throw new UnsupportedOperationException();
144 }
145
146 /**
147 * Returns read-only map of supported provider specific configuration
148 * properties that are used to configure the created JSON builders.
149 * If there are any specified configuration properties that are not
150 * supported by the provider, they won't be part of the returned map.
151 *
152 * @return a map of supported provider specific properties that are used
153 * to configure the builders. The map be empty but not null.
154 */
155 Map<String, ?> getConfigInUse();
156
157}
Note: See TracBrowser for help on using the repository browser.