Index: trunk/src/javax/json/spi/JsonProvider.java =================================================================== --- trunk/src/javax/json/spi/JsonProvider.java (revision 13231) +++ (revision ) @@ -1,504 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2011-2017 Oracle and/or its affiliates. All rights reserved. - * - * The contents of this file are subject to the terms of either the GNU - * General Public License Version 2 only ("GPL") or the Common Development - * and Distribution License("CDDL") (collectively, the "License"). You - * may not use this file except in compliance with the License. You can - * obtain a copy of the License at - * https://oss.oracle.com/licenses/CDDL+GPL-1.1 - * or LICENSE.txt. See the License for the specific - * language governing permissions and limitations under the License. - * - * When distributing the software, include this License Header Notice in each - * file and include the License file at LICENSE.txt. - * - * GPL Classpath Exception: - * Oracle designates this particular file as subject to the "Classpath" - * exception as provided by Oracle in the GPL Version 2 section of the License - * file that accompanied this code. - * - * Modifications: - * If applicable, add the following below the License Header, with the fields - * enclosed by brackets [] replaced by your own identifying information: - * "Portions Copyright [year] [name of copyright owner]" - * - * Contributor(s): - * If you wish your version of this file to be governed by only the CDDL or - * only the GPL Version 2, indicate your decision by adding "[Contributor] - * elects to include this software in this distribution under the [CDDL or GPL - * Version 2] license." If you don't indicate a single choice of license, a - * recipient has the option to distribute your version of this file under - * either the CDDL, the GPL Version 2 or to extend the choice of license to - * its licensees as provided above. However, if you add GPL Version 2 code - * and therefore, elected the GPL Version 2 license, then the option applies - * only if the new code is made subject to such option by the copyright - * holder. - */ - -package javax.json.spi; - -import javax.json.*; -import javax.json.stream.JsonGenerator; -import javax.json.stream.JsonGeneratorFactory; -import javax.json.stream.JsonParser; -import javax.json.stream.JsonParserFactory; -import java.io.InputStream; -import java.io.OutputStream; -import java.io.Reader; -import java.io.Writer; -import java.util.Collection; -import java.util.Iterator; -import java.util.Map; -import java.util.ServiceLoader; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.util.Optional; - -/** - * Service provider for JSON processing objects. - * - *

All the methods in this class are safe for use by multiple concurrent - * threads. - * - * @see ServiceLoader - */ -public abstract class JsonProvider { - - /** - * A constant representing the name of the default - * {@code JsonProvider} implementation class. - */ - private static final String DEFAULT_PROVIDER - = "org.glassfish.json.JsonProviderImpl"; - - protected JsonProvider() { - } - - /** - * Creates a JSON provider object. The provider is loaded using the - * {@link ServiceLoader#load(Class)} method. If there are no available - * service providers, this method returns the default service provider. - * Users are recommended to cache the result of this method. - * - * @see ServiceLoader - * @return a JSON provider - */ - public static JsonProvider provider() { - ServiceLoader loader = ServiceLoader.load(JsonProvider.class); - Iterator it = loader.iterator(); - if (it.hasNext()) { - return it.next(); - } - try { - Class clazz = Class.forName(DEFAULT_PROVIDER); - return (JsonProvider) clazz.newInstance(); - } catch (ClassNotFoundException x) { - throw new JsonException( - "Provider " + DEFAULT_PROVIDER + " not found", x); - } catch (Exception x) { - throw new JsonException( - "Provider " + DEFAULT_PROVIDER + " could not be instantiated: " + x, - x); - } - } - - /** - * Creates a JSON parser from a character stream. - * - * @param reader i/o reader from which JSON is to be read - * @return a JSON parser - */ - public abstract JsonParser createParser(Reader reader); - - /** - * Creates a JSON parser from the specified byte stream. - * The character encoding of the stream is determined - * as defined in RFC 7159 - * . - * - * @param in i/o stream from which JSON is to be read - * @throws JsonException if encoding cannot be determined - * or i/o error (IOException would be cause of JsonException) - * @return a JSON parser - */ - public abstract JsonParser createParser(InputStream in); - - /** - * Creates a parser factory for creating {@link JsonParser} instances. - * - * @return a JSON parser factory - * - public abstract JsonParserFactory createParserFactory(); - */ - - /** - * Creates a parser factory for creating {@link JsonParser} instances. - * The factory is configured with the specified map of - * provider specific configuration properties. Provider implementations - * should ignore any unsupported configuration properties specified in - * the map. - * - * @param config a map of provider specific properties to configure the - * JSON parsers. The map may be empty or null - * @return a JSON parser factory - */ - public abstract JsonParserFactory createParserFactory(Map config); - - /** - * Creates a JSON generator for writing JSON text to a character stream. - * - * @param writer a i/o writer to which JSON is written - * @return a JSON generator - */ - public abstract JsonGenerator createGenerator(Writer writer); - - /** - * Creates a JSON generator for writing JSON text to a byte stream. - * - * @param out i/o stream to which JSON is written - * @return a JSON generator - */ - public abstract JsonGenerator createGenerator(OutputStream out); - - /** - * Creates a generator factory for creating {@link JsonGenerator} instances. - * - * @return a JSON generator factory - * - public abstract JsonGeneratorFactory createGeneratorFactory(); - */ - - /** - * Creates a generator factory for creating {@link JsonGenerator} instances. - * The factory is configured with the specified map of provider specific - * configuration properties. Provider implementations should - * ignore any unsupported configuration properties specified in the map. - * - * @param config a map of provider specific properties to configure the - * JSON generators. The map may be empty or null - * @return a JSON generator factory - */ - public abstract JsonGeneratorFactory createGeneratorFactory(Map config); - - /** - * Creates a JSON reader from a character stream. - * - * @param reader a reader from which JSON is to be read - * @return a JSON reader - */ - public abstract JsonReader createReader(Reader reader); - - /** - * Creates a JSON reader from a byte stream. The character encoding of - * the stream is determined as described in - * RFC 7159. - * - * @param in a byte stream from which JSON is to be read - * @return a JSON reader - */ - public abstract JsonReader createReader(InputStream in); - - /** - * Creates a JSON writer to write a - * JSON {@link JsonObject object} or {@link JsonArray array} - * structure to the specified character stream. - * - * @param writer to which JSON object or array is written - * @return a JSON writer - */ - public abstract JsonWriter createWriter(Writer writer); - - /** - * Creates a JSON writer to write a - * JSON {@link JsonObject object} or {@link JsonArray array} - * structure to the specified byte stream. Characters written to - * the stream are encoded into bytes using UTF-8 encoding. - * - * @param out to which JSON object or array is written - * @return a JSON writer - */ - public abstract JsonWriter createWriter(OutputStream out); - - /** - * Creates a writer factory for creating {@link JsonWriter} objects. - * The factory is configured with the specified map of provider specific - * configuration properties. Provider implementations should ignore any - * unsupported configuration properties specified in the map. - * - * @param config a map of provider specific properties to configure the - * JSON writers. The map may be empty or null - * @return a JSON writer factory - */ - public abstract JsonWriterFactory createWriterFactory(Map config); - - /** - * Creates a reader factory for creating {@link JsonReader} objects. - * The factory is configured with the specified map of provider specific - * configuration properties. Provider implementations should ignore any - * unsupported configuration properties specified in the map. - * - * @param config a map of provider specific properties to configure the - * JSON readers. The map may be empty or null - * @return a JSON reader factory - */ - public abstract JsonReaderFactory createReaderFactory(Map config); - - /** - * Creates a JSON object builder. - * - * @return a JSON object builder - */ - public abstract JsonObjectBuilder createObjectBuilder(); - - /** - * Creates a JSON object builder, initialized with the specified object. - * - * @param object the initial JSON object in the builder - * @return a JSON object builder - * - * @since 1.1 - */ - public JsonObjectBuilder createObjectBuilder(JsonObject object) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JSON object builder, initialized with the data from specified {@code map}. - * If the @{code map} contains {@link Optional}s then resulting JSON object builder - * contains the key from the {@code map} only if the {@link Optional} is not empty. - * - * @param map the initial object in the builder - * @return a JSON object builder - * @exception IllegalArgumentException if the value from the {@code map} cannot be converted - * to the corresponding {@link JsonValue} - * - * @since 1.1 - */ - public JsonObjectBuilder createObjectBuilder(Map map) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JSON array builder. - * - * @return a JSON array builder - */ - public abstract JsonArrayBuilder createArrayBuilder(); - - /** - * Creates a JSON array builder, initialized with the specified array. - * - * @param array the initial JSON array in the builder - * @return a JSON array builder - * - * @since 1.1 - */ - public JsonArrayBuilder createArrayBuilder(JsonArray array) { - throw new UnsupportedOperationException(); - } - - /** - * Creates JSON Pointer (RFC 6901) - * from given {@code jsonPointer} string. - *

- * - * @param jsonPointer the JSON Pointer string - * @throws NullPointerException if {@code jsonPointer} is {@code null} - * @throws JsonException if {@code jsonPointer} is not a valid JSON Pointer - * @return a JSON Pointer - * - * @since 1.1 - */ - public JsonPointer createPointer(String jsonPointer) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JSON Patch builder (RFC 6902). - * - * @return a JSON Patch builder - * - * @since 1.1 - */ - public JsonPatchBuilder createPatchBuilder() { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JSON Patch builder - * (RFC 6902), - * initialized with the specified operations. - * - * @param array the initial patch operations - * @return a JSON Patch builder - * - * @since 1.1 - */ - public JsonPatchBuilder createPatchBuilder(JsonArray array) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JSON Patch (RFC 6902) - * from the specified operations. - * - * @param array patch operations - * @return a JSON Patch - * - * @since 1.1 - */ - public JsonPatch createPatch(JsonArray array) { - throw new UnsupportedOperationException(); - } - - /** - * Generates a JSON Patch (RFC 6902) - * from the source and target {@code JsonStructure}. - * The generated JSON Patch need not be unique. - * - * @param source the source - * @param target the target, must be the same type as the source - * @return a JSON Patch which when applied to the source, yields the target - * - * @since 1.1 - */ - public JsonPatch createDiff(JsonStructure source, JsonStructure target) { - throw new UnsupportedOperationException(); - } - - /** - * Creates JSON Merge Patch (RFC 7396) - * from specified {@code JsonValue}. - * - * @param patch the patch - * @return a JSON Merge Patch - * - * @since 1.1 - */ - public JsonMergePatch createMergePatch(JsonValue patch) { - throw new UnsupportedOperationException(); - } - - /** - * Generates a JSON Merge Patch (RFC 7396) - * from the source and target {@code JsonValue}s - * which when applied to the {@code source}, yields the {@code target}. - * - * @param source the source - * @param target the target - * @return a JSON Merge Patch - * - * @since 1.1 - */ - public JsonMergePatch createMergeDiff(JsonValue source, JsonValue target) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JSON array builder, initialized with the content of specified {@code collection}. - * If the @{code collection} contains {@link Optional}s then resulting JSON array builder - * contains the value from the {@code collection} only if the {@link Optional} is not empty. - * - * @param collection the initial data for the builder - * @return a JSON array builder - * @exception IllegalArgumentException if the value from the {@code collection} cannot be converted - * to the corresponding {@link JsonValue} - * - * @since 1.1 - */ - public JsonArrayBuilder createArrayBuilder(Collection collection) { - throw new UnsupportedOperationException(); - } - - - /** - * Creates a builder factory for creating {@link JsonArrayBuilder} - * and {@link JsonObjectBuilder} objects. - * The factory is configured with the specified map of provider specific - * configuration properties. Provider implementations should ignore any - * unsupported configuration properties specified in the map. - * - * @param config a map of provider specific properties to configure the - * JSON builders. The map may be empty or null - * @return a JSON builder factory - */ - public abstract JsonBuilderFactory createBuilderFactory(Map config); - - /** - * Creates a JsonString. - * - * @param value a JSON string - * @return the JsonString for the string - * - * @since 1.1 - */ - public JsonString createValue(String value) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public JsonNumber createValue(int value) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public JsonNumber createValue(long value) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public JsonNumber createValue(double value) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public JsonNumber createValue(BigDecimal value) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public JsonNumber createValue(BigInteger value) { - throw new UnsupportedOperationException(); - } -} Index: trunk/src/javax/json/spi/package-info.java =================================================================== --- trunk/src/javax/json/spi/package-info.java (revision 13231) +++ (revision ) @@ -1,56 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved. - * - * The contents of this file are subject to the terms of either the GNU - * General Public License Version 2 only ("GPL") or the Common Development - * and Distribution License("CDDL") (collectively, the "License"). You - * may not use this file except in compliance with the License. You can - * obtain a copy of the License at - * https://oss.oracle.com/licenses/CDDL+GPL-1.1 - * or LICENSE.txt. See the License for the specific - * language governing permissions and limitations under the License. - * - * When distributing the software, include this License Header Notice in each - * file and include the License file at LICENSE.txt. - * - * GPL Classpath Exception: - * Oracle designates this particular file as subject to the "Classpath" - * exception as provided by Oracle in the GPL Version 2 section of the License - * file that accompanied this code. - * - * Modifications: - * If applicable, add the following below the License Header, with the fields - * enclosed by brackets [] replaced by your own identifying information: - * "Portions Copyright [year] [name of copyright owner]" - * - * Contributor(s): - * If you wish your version of this file to be governed by only the CDDL or - * only the GPL Version 2, indicate your decision by adding "[Contributor] - * elects to include this software in this distribution under the [CDDL or GPL - * Version 2] license." If you don't indicate a single choice of license, a - * recipient has the option to distribute your version of this file under - * either the CDDL, the GPL Version 2 or to extend the choice of license to - * its licensees as provided above. However, if you add GPL Version 2 code - * and therefore, elected the GPL Version 2 license, then the option applies - * only if the new code is made subject to such option by the copyright - * holder. - */ - -/** - * Service Provider Interface (SPI) to plug in implementations for - * JSON processing objects. - * - *

{@link javax.json.spi.JsonProvider JsonProvider} is an abstract class - * that provides a service for creating JSON processing instances. - * A service provider for {@code JsonProvider} provides an - * specific implementation by subclassing and implementing the methods in - * {@code JsonProvider}. This enables using custom, efficient JSON processing - * implementations (for e.g. parser and generator) other than the default ones. - * - *

The API locates and loads providers using {@link java.util.ServiceLoader}. - * - * @since JSON Processing 1.0 - */ -package javax.json.spi;