Index: trunk/src/javax/json/EmptyArray.java =================================================================== --- trunk/src/javax/json/EmptyArray.java (revision 14273) +++ (revision ) @@ -1,136 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 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; - -import java.io.Serializable; -import java.util.AbstractList; -import java.util.Collections; -import java.util.List; -import java.util.RandomAccess; - -/** - * Private implementation of immutable {@link JsonArray}. - * - * @author Lukas Jungmann - */ -final class EmptyArray extends AbstractList implements JsonArray, Serializable, RandomAccess { - - private static final long serialVersionUID = 7295439472061642859L; - - @Override - public JsonValue get(int index) { - throw new IndexOutOfBoundsException("Index: " + index); - } - - @Override - public int size() { - return 0; - } - - @Override - public JsonObject getJsonObject(int index) { - return (JsonObject) get(index); - } - - @Override - public JsonArray getJsonArray(int index) { - return (JsonArray) get(index); - } - - @Override - public JsonNumber getJsonNumber(int index) { - return (JsonNumber) get(index); - } - - @Override - public JsonString getJsonString(int index) { - return (JsonString) get(index); - } - - @Override - public List getValuesAs(Class clazz) { - return Collections.emptyList(); - } - - @Override - public String getString(int index) { - return getJsonString(index).getString(); - } - - @Override - public String getString(int index, String defaultValue) { - return defaultValue; - } - - @Override - public int getInt(int index) { - return getJsonNumber(index).intValue(); - } - - @Override - public int getInt(int index, int defaultValue) { - return defaultValue; - } - - @Override - public boolean getBoolean(int index) { - return get(index) == JsonValue.TRUE; - } - - @Override - public boolean getBoolean(int index, boolean defaultValue) { - return defaultValue; - } - - @Override - public boolean isNull(int index) { - return get(index) == JsonValue.NULL; - } - - @Override - public ValueType getValueType() { - return ValueType.ARRAY; - } - - // Preserves singleton property - private Object readResolve() { - return JsonValue.EMPTY_JSON_ARRAY; - } -} Index: trunk/src/javax/json/EmptyObject.java =================================================================== --- trunk/src/javax/json/EmptyObject.java (revision 14273) +++ (revision ) @@ -1,126 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 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; - -import java.io.Serializable; -import java.util.AbstractMap; -import java.util.Collections; -import java.util.Set; - -/** - * Private implementation of immutable {@link JsonObject}. - * - * @author Lukas Jungmann - */ -final class EmptyObject extends AbstractMap implements JsonObject, Serializable { - - private static final long serialVersionUID = -1461653546889072583L; - - @Override - public Set> entrySet() { - return Collections.>emptySet(); - } - - @Override - public JsonArray getJsonArray(String name) { - return (JsonArray) get(name); - } - - @Override - public JsonObject getJsonObject(String name) { - return (JsonObject) get(name); - } - - @Override - public JsonNumber getJsonNumber(String name) { - return (JsonNumber) get(name); - } - - @Override - public JsonString getJsonString(String name) { - return (JsonString) get(name); - } - - @Override - public String getString(String name) { - return getJsonString(name).getString(); - } - - @Override - public String getString(String name, String defaultValue) { - return defaultValue; - } - - @Override - public int getInt(String name) { - return getJsonNumber(name).intValue(); - } - - @Override - public int getInt(String name, int defaultValue) { - return defaultValue; - } - - @Override - public boolean getBoolean(String name) { - throw new NullPointerException(); - } - - @Override - public boolean getBoolean(String name, boolean defaultValue) { - return defaultValue; - } - - @Override - public boolean isNull(String name) { - throw new NullPointerException(); - } - - @Override - public ValueType getValueType() { - return ValueType.OBJECT; - } - - // Preserves singleton property - private Object readResolve() { - return JsonValue.EMPTY_JSON_OBJECT; - } -} Index: trunk/src/javax/json/Json.java =================================================================== --- trunk/src/javax/json/Json.java (revision 14273) +++ (revision ) @@ -1,544 +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; - -import java.io.InputStream; -import java.io.OutputStream; -import java.io.Reader; -import java.io.Writer; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.util.Collection; -import java.util.Map; -import java.util.Optional; -import javax.json.spi.JsonProvider; -import javax.json.stream.JsonGenerator; -import javax.json.stream.JsonGeneratorFactory; -import javax.json.stream.JsonParser; -import javax.json.stream.JsonParserFactory; - -/** - * Factory class for creating JSON processing objects. - * This class provides the most commonly used methods for creating these - * objects and their corresponding factories. The factory classes provide - * all the various ways to create these objects. - * - *

- * The methods in this class locate a provider instance using the method - * {@link JsonProvider#provider()}. This class uses the provider instance - * to create JSON processing objects. - * - *

- * The following example shows how to create a JSON parser to parse - * an empty array: - * 

- * 
- * StringReader reader = new StringReader("[]");
- * JsonParser parser = Json.createParser(reader);
- * 
- *
- * - *

- * All the methods in this class are safe for use by multiple concurrent - * threads. - */ -public final class Json { - - private Json() { - } - - /** - * 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 static JsonParser createParser(Reader reader) { - return JsonProvider.provider().createParser(reader); - } - - /** - * Creates a JSON parser from a byte stream. - * The character encoding of the stream is determined as specified 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 static JsonParser createParser(InputStream in) { - return JsonProvider.provider().createParser(in); - } - - /** - * Creates a JSON generator for writing JSON to a character stream. - * - * @param writer a i/o writer to which JSON is written - * @return a JSON generator - */ - public static JsonGenerator createGenerator(Writer writer) { - return JsonProvider.provider().createGenerator(writer); - } - - /** - * Creates a JSON generator for writing JSON to a byte stream. - * - * @param out i/o stream to which JSON is written - * @return a JSON generator - */ - public static JsonGenerator createGenerator(OutputStream out) { - return JsonProvider.provider().createGenerator(out); - } - - /** - * Creates a parser factory for creating {@link JsonParser} objects. - * - * @return JSON parser factory. - * - public static JsonParserFactory createParserFactory() { - return JsonProvider.provider().createParserFactory(); - } - */ - - /** - * Creates a parser factory for creating {@link JsonParser} 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 parsers. The map may be empty or null - * @return JSON parser factory - */ - public static JsonParserFactory createParserFactory(Map config) { - return JsonProvider.provider().createParserFactory(config); - } - - /** - * Creates a generator factory for creating {@link JsonGenerator} objects. - * - * @return JSON generator factory - * - public static JsonGeneratorFactory createGeneratorFactory() { - return JsonProvider.provider().createGeneratorFactory(); - } - */ - - /** - * Creates a generator factory for creating {@link JsonGenerator} 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 generators. The map may be empty or null - * @return JSON generator factory - */ - public static JsonGeneratorFactory createGeneratorFactory( - Map config) { - return JsonProvider.provider().createGeneratorFactory(config); - } - - /** - * 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 static JsonWriter createWriter(Writer writer) { - return JsonProvider.provider().createWriter(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 static JsonWriter createWriter(OutputStream out) { - return JsonProvider.provider().createWriter(out); - } - - /** - * Creates a JSON reader from a character stream. - * - * @param reader a reader from which JSON is to be read - * @return a JSON reader - */ - public static JsonReader createReader(Reader reader) { - return JsonProvider.provider().createReader(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 static JsonReader createReader(InputStream in) { - return JsonProvider.provider().createReader(in); - } - - /** - * 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 static JsonReaderFactory createReaderFactory(Map config) { - return JsonProvider.provider().createReaderFactory(config); - } - - /** - * 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 static JsonWriterFactory createWriterFactory(Map config) { - return JsonProvider.provider().createWriterFactory(config); - } - - /** - * Creates a JSON array builder - * - * @return a JSON array builder - */ - public static JsonArrayBuilder createArrayBuilder() { - return JsonProvider.provider().createArrayBuilder(); - } - - /** - * Creates a JSON array builder, initialized with the specified array - * - * @param array the initial array in the builder - * @return a JSON array builder - * - * @since 1.1 - */ - public static JsonArrayBuilder createArrayBuilder(JsonArray array) { - return JsonProvider.provider().createArrayBuilder(array); - } - - /** - * 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 static JsonArrayBuilder createArrayBuilder(Collection collection) { - return JsonProvider.provider().createArrayBuilder(collection); - } - - /** - * Creates a JSON object builder - * - * @return a JSON object builder - */ - public static JsonObjectBuilder createObjectBuilder() { - return JsonProvider.provider().createObjectBuilder(); - } - - /** - * Creates a JSON object builder, initialized with the specified object. - * - * @param object the initial object in the builder - * @return a JSON object builder - * - * @since 1.1 - */ - public static JsonObjectBuilder createObjectBuilder(JsonObject object) { - return JsonProvider.provider().createObjectBuilder(object); - } - - /** - * 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 static JsonObjectBuilder createObjectBuilder(Map map) { - return JsonProvider.provider().createObjectBuilder(map); - } - - /** - * Creates JSON Pointer (RFC 6901) - * from given {@code jsonPointer} string. - *

    - *
  • An empty {@code jsonPointer} string defines a reference to the target itself.
    • - *
  • If the {@code jsonPointer} string is non-empty, it must be a sequence of '{@code /}' prefixed tokens.
    • - *
- * - * @param jsonPointer the valid escaped 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 static JsonPointer createPointer(String jsonPointer) { - return JsonProvider.provider().createPointer(jsonPointer); - } - - /** - * Creates a JSON Patch builder (RFC 6902). - * - * @return a JSON Patch builder - * - * @since 1.1 - */ - public static JsonPatchBuilder createPatchBuilder() { - return JsonProvider.provider().createPatchBuilder(); - } - - /** - * 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 static JsonPatchBuilder createPatchBuilder(JsonArray array) { - return JsonProvider.provider().createPatchBuilder(array); - } - - /** - * Creates a JSON Patch (RFC 6902) - * from the specified operations. - * - * @param array patch operations - * @return a JSON Patch - * - * @since 1.1 - */ - public static JsonPatch createPatch(JsonArray array) { - return JsonProvider.provider().createPatch(array); - } - - /** - * 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 static JsonPatch createDiff(JsonStructure source, JsonStructure target) { - return JsonProvider.provider().createDiff(source, target); - } - - /** - * Creates JSON Merge Patch (RFC 7396) - * from specified {@code JsonValue}. - * - * @param patch the patch - * @return a JSON Merge Patch - * - * @since 1.1 - */ - public static JsonMergePatch createMergePatch(JsonValue patch) { - return JsonProvider.provider().createMergePatch(patch); - } - - /** - * 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 static JsonMergePatch createMergeDiff(JsonValue source, JsonValue target) { - return JsonProvider.provider().createMergeDiff(source, target); - } - - /** - * 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 static JsonBuilderFactory createBuilderFactory( - Map config) { - return JsonProvider.provider().createBuilderFactory(config); - } - - /** - * Creates a JsonString. - * - * @param value a JSON string - * @return the JsonString for the string - * - * @since 1.1 - */ - public static JsonString createValue(String value) { - return JsonProvider.provider().createValue(value); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public static JsonNumber createValue(int value) { - return JsonProvider.provider().createValue(value); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public static JsonNumber createValue(long value) { - return JsonProvider.provider().createValue(value); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public static JsonNumber createValue(double value) { - return JsonProvider.provider().createValue(value); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public static JsonNumber createValue(BigDecimal value) { - return JsonProvider.provider().createValue(value); - } - - /** - * Creates a JsonNumber. - * - * @param value a JSON number - * @return the JsonNumber for the number - * - * @since 1.1 - */ - public static JsonNumber createValue(BigInteger value) { - return JsonProvider.provider().createValue(value); - } - - /** - * Encodes (escapes) a passed string as defined by RFC 6901. - * This method doesn't validate the passed JSON-pointer string. - * - * @param pointer the JSON-pointer string to encode - * @return encoded JSON-pointer string - * - * @since 1.1 - */ - public static String encodePointer(String pointer) { - return pointer.replace("~", "~0").replace("/", "~1"); - } - - /** - * Decodes a passed JSON-pointer string as defined by RFC 6901. - * This method doesn't validate the passed JSON-pointer string. - * - * @param escaped the JSON-pointer string to decode - * @return decoded JSON-pointer string - * - * @since 1.1 - */ - public static String decodePointer(String escaped) { - return escaped.replace("~1", "/").replace("~0", "~"); - } - -} Index: trunk/src/javax/json/JsonArray.java =================================================================== --- trunk/src/javax/json/JsonArray.java (revision 14273) +++ (revision ) @@ -1,298 +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; - -import java.util.List; -import java.util.function.Function; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -/** - * {@code JsonArray} represents an immutable JSON array - * (an ordered sequence of zero or more values). - * It also provides an unmodifiable list view of the values in the array. - * - *

A {@code JsonArray} object can be created by reading JSON data from - * an input source or it can be built from scratch using an array builder - * object. - * - *

The following example demonstrates how to create a {@code JsonArray} - * object from an input source using the method {@link JsonReader#readArray()}: - * 


- * JsonReader jsonReader = Json.createReader(...);
- * JsonArray array = jsonReader.readArray();
- * jsonReader.close();
- *
- * - *

The following example demonstrates how to build an empty JSON array - * using the class {@link JsonArrayBuilder}: - * 


- * JsonArray array = Json.createArrayBuilder().build();
- *
- * - *

The example code below demonstrates how to create the following JSON array: - * 


- * [
- *     { "type": "home", "number": "212 555-1234" },
- *     { "type": "fax", "number": "646 555-4567" }
- * ]
- *
- * 

- * JsonArray value = Json.createArrayBuilder()
- *     .add(Json.createObjectBuilder()
- *         .add("type", "home")
- *         .add("number", "212 555-1234"))
- *     .add(Json.createObjectBuilder()
- *         .add("type", "fax")
- *         .add("number", "646 555-4567"))
- *     .build();
- *
- * - *

The following example demonstrates how to write a {@code JsonArray} object - * as JSON data: - * 


- * JsonArray arr = ...;
- * JsonWriter writer = Json.createWriter(...)
- * writer.writeArray(arr);
- * writer.close();
- *
- * - *

The values in a {@code JsonArray} can be of the following types: - * {@link JsonObject}, {@link JsonArray}, - * {@link JsonString}, {@link JsonNumber}, {@link JsonValue#TRUE}, - * {@link JsonValue#FALSE}, and {@link JsonValue#NULL}. - * {@code JsonArray} provides various accessor methods to access the values - * in an array. - * - *

The following example shows how to obtain the home phone number - * "212 555-1234" from the array built in the previous example: - * 


- * JsonObject home = array.getJsonObject(0);
- * String number = home.getString("number");
- *
- * - *

{@code JsonArray} instances are list objects that provide read-only - * access to the values in the JSON array. Any attempt to modify the list, - * whether directly or using its collection views, results in an - * {@code UnsupportedOperationException}. - */ -public interface JsonArray extends JsonStructure, List { - - /** - * Returns the object value at the specified position in this array. - * This is a convenience method for {@code (JsonObject)get(index)}. - * - * @param index index of the value to be returned - * @return the value at the specified position in this array - * @throws IndexOutOfBoundsException if the index is out of range - * @throws ClassCastException if the value at the specified position is not - * assignable to the JsonObject type - */ - JsonObject getJsonObject(int index); - - /** - * Returns the array value at the specified position in this array. - * This is a convenience method for {@code (JsonArray)get(index)}. - * - * @param index index of the value to be returned - * @return the value at the specified position in this array - * @throws IndexOutOfBoundsException if the index is out of range - * @throws ClassCastException if the value at the specified position is not - * assignable to the JsonArray type - */ - JsonArray getJsonArray(int index); - - /** - * Returns the number value at the specified position in this array. - * This is a convenience method for {@code (JsonNumber)get(index)}. - * - * @param index index of the value to be returned - * @return the value at the specified position in this array - * @throws IndexOutOfBoundsException if the index is out of range - * @throws ClassCastException if the value at the specified position is not - * assignable to the JsonNumber type - */ - JsonNumber getJsonNumber(int index); - - /** - * Returns the string value at ths specified position in this array. - * This is a convenience method for {@code (JsonString)get(index)}. - * - * @param index index of the value to be returned - * @return the value at the specified position in this array - * @throws IndexOutOfBoundsException if the index is out of range - * @throws ClassCastException if the value at the specified position is not - * assignable to the JsonString type - */ - JsonString getJsonString(int index); - - /** - * Returns a list view of the specified type for the array. This method - * does not verify if there is a value of wrong type in the array. Providing - * this typesafe view dynamically may cause a program fail with a - * {@code ClassCastException}, if there is a value of wrong type in this - * array. Unfortunately, the exception can occur at any time after this - * method returns. - * - * @param The type of the List for the array - * @param clazz a JsonValue type - * @return a list view of the specified type - */ - List getValuesAs(Class clazz); - - /** - * Returns a list view for the array. The value and the type of the elements - * in the list is specified by the {@code func} argument. - *

This method can be used to obtain a list of the unwrapped types, such as - * 

{@code
-     *     List strings = ary1.getValuesAs(JsonString::getString);
-     *     List ints = ary2.getValuesAs(JsonNumber::intValue);
-     * }
- * or a list of simple projections, such as - * 
 {@code
-     *     List stringsizes = ary1.getValueAs((JsonString v)->v.getString().length();
-     * }
- * @param The element type (must be a subtype of JsonValue) of this JsonArray. - * @param The element type of the returned List - * @param func The function that maps the elements of this JsonArray to the target elements. - * @return A List of the specified values and type. - * @throws ClassCastException if the {@code JsonArray} contains a value of wrong type - * - * @since 1.1 - */ - default List getValuesAs(Function func) { - @SuppressWarnings("unchecked") - Stream stream = (Stream) stream(); - return stream.map(func).collect(Collectors.toList()); - } - - /** - * A convenience method for - * {@code getJsonString(index).getString()}. - * - * @param index index of the {@code JsonString} value - * @return the String value at the specified position - * @throws IndexOutOfBoundsException if the index is out of range - * @throws ClassCastException if the value at the specified position is not - * assignable to {@code JsonString} - */ - String getString(int index); - - /** - * Returns the {@code String} value of {@code JsonString} at the specified - * position in this JSON array values. If {@code JsonString} is found, - * its {@link javax.json.JsonString#getString()} is returned. Otherwise, - * the specified default value is returned. - * - * @param index index of the {@code JsonString} value - * @param defaultValue the String to return if the {@code JsonValue} at the - * specified position is not a {@code JsonString} - * @return the String value at the specified position in this array, - * or the specified default value - */ - String getString(int index, String defaultValue); - - /** - * A convenience method for - * {@code getJsonNumber(index).intValue()}. - * - * @param index index of the {@code JsonNumber} value - * @return the int value at the specified position - * @throws IndexOutOfBoundsException if the index is out of range - * @throws ClassCastException if the value at the specified position is not - * assignable to {@code JsonNumber} - */ - int getInt(int index); - - /** - * Returns the int value of the {@code JsonNumber} at the specified position. - * If the value at that position is a {@code JsonNumber}, - * this method returns {@link javax.json.JsonNumber#intValue()}. Otherwise - * this method returns the specified default value. - * - * @param index index of the {@code JsonNumber} value - * @param defaultValue the int value to return if the {@code JsonValue} at - * the specified position is not a {@code JsonNumber} - * @return the int value at the specified position in this array, - * or the specified default value - */ - int getInt(int index, int defaultValue); - - /** - * Returns the boolean value at the specified position. - * If the value at the specified position is {@code JsonValue.TRUE} - * this method returns {@code true}. If the value at the specified position - * is {@code JsonValue.FALSE} this method returns {@code false}. - * - * @param index index of the JSON boolean value - * @return the boolean value at the specified position - * @throws IndexOutOfBoundsException if the index is out of range - * @throws ClassCastException if the value at the specified position is not - * assignable to {@code JsonValue.TRUE} or {@code JsonValue.FALSE} - */ - boolean getBoolean(int index); - - /** - * Returns the boolean value at the specified position. - * If the value at the specified position is {@code JsonValue.TRUE} - * this method returns {@code true}. If the value at the specified position - * is {@code JsonValue.FALSE} this method returns {@code false}. - * Otherwise this method returns the specified default value. - * - * @param index index of the JSON boolean value - * @param defaultValue the boolean value to return if the {@code JsonValue} - * at the specified position is neither TRUE nor FALSE - * @return the boolean value at the specified position, - * or the specified default value - */ - boolean getBoolean(int index, boolean defaultValue); - - /** - * Returns {@code true} if the value at the specified location in this - * array is {@code JsonValue.NULL}. - * - * @param index index of the JSON null value - * @return return true if the value at the specified location is - * {@code JsonValue.NULL}, otherwise false - * @throws IndexOutOfBoundsException if the index is out of range - */ - boolean isNull(int index); -} Index: trunk/src/javax/json/JsonArrayBuilder.java =================================================================== --- trunk/src/javax/json/JsonArrayBuilder.java (revision 14273) +++ (revision ) @@ -1,646 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2013-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; - -import java.math.BigDecimal; -import java.math.BigInteger; - -/** - * A builder for creating {@link JsonArray} models from scratch, and for - * modifying a existing {@code JsonArray}. - *

A {@code JsonArrayBuilder} can start with an empty or a non-empty - * JSON array model. This interface provides methods to add, insert, remove - * and replace values in the JSON array model.

- *

Methods in this class can be chained to perform multiple values to - * the array.

- * - *

The class {@link javax.json.Json} contains methods to create the builder - * object. The example code below shows how to build an empty {@code JsonArray} - * instance. - * 

- * 
- * JsonArray array = Json.createArrayBuilder().build();
- * 
- *
- * - *

The class {@link JsonBuilderFactory} also contains methods to create - * {@code JsonArrayBuilder} instances. A factory instance can be used to create - * multiple builder instances with the same configuration. This the preferred - * way to create multiple instances. - * - * The example code below shows how to build a {@code JsonArray} object - * that represents the following JSON array: - * - * 

- * 
- * [
- *     { "type": "home", "number": "212 555-1234" },
- *     { "type": "fax", "number": "646 555-4567" }
- * ]
- * 
- *
- * - *

The following code creates the JSON array above: - * - * 

- * 
- * JsonBuilderFactory factory = Json.createBuilderFactory(config);
- * JsonArray value = factory.createArrayBuilder()
- *     .add(factory.createObjectBuilder()
- *         .add("type", "home")
- *         .add("number", "212 555-1234"))
- *     .add(factory.createObjectBuilder()
- *         .add("type", "fax")
- *         .add("number", "646 555-4567"))
- *     .build();
- * 
- *
- * - *

This class does not allow null to be used as a - * value while building the JSON array - * - * @see JsonObjectBuilder - */ -public interface JsonArrayBuilder { - - /** - * Adds a value to the array. - * - * @param value the JSON value - * @return this array builder - * @throws NullPointerException if the specified value is null - */ - JsonArrayBuilder add(JsonValue value); - - /** - * Adds a value to the array as a {@link JsonString}. - * - * @param value the string value - * @return this array builder - * @throws NullPointerException if the specified value is null - */ - JsonArrayBuilder add(String value); - - /** - * Adds a value to the array as a {@link JsonNumber}. - * - * @param value the number value - * @return this array builder - * @throws NullPointerException if the specified value is null - * - * @see JsonNumber - */ - JsonArrayBuilder add(BigDecimal value); - - /** - * Adds a value to the array as a {@link JsonNumber}. - * - * @param value the number value - * @return this array builder - * @throws NullPointerException if the specified value is null - * - * @see JsonNumber - */ - JsonArrayBuilder add(BigInteger value); - - /** - * Adds a value to the array as a {@link JsonNumber}. - * - * @param value the number value - * @return this array builder - * - * @see JsonNumber - */ - JsonArrayBuilder add(int value); - - /** - * Adds a value to the array as a {@link JsonNumber}. - * - * @param value the number value - * @return this array builder - * - * @see JsonNumber - */ - JsonArrayBuilder add(long value); - - /** - * Adds a value to the array as a {@link JsonNumber}. - * - * @param value the number value - * @return this array builder - * @throws NumberFormatException if the value is Not-a-Number (NaN) or - * infinity - * - * @see JsonNumber - */ - JsonArrayBuilder add(double value); - - /** - * Adds a {@link JsonValue#TRUE} or {@link JsonValue#FALSE} value to the - * array. - * - * @param value the boolean value - * @return this array builder - */ - JsonArrayBuilder add(boolean value); - - /** - * Adds a {@link JsonValue#NULL} value to the array. - * - * @return this array builder - */ - JsonArrayBuilder addNull(); - - /** - * Adds a {@link JsonObject} from an object builder to the array. - * - * @param builder the object builder - * @return this array builder - * @throws NullPointerException if the specified builder is null - */ - JsonArrayBuilder add(JsonObjectBuilder builder); - - /** - * Adds a {@link JsonArray} from an array builder to the array. - * - * @param builder the array builder - * @return this array builder - * @throws NullPointerException if the specified builder is null - */ - JsonArrayBuilder add(JsonArrayBuilder builder); - - /** - * Adds all elements of the array in the specified array builder to the array. - * - * @param builder the array builder - * @return this array builder - * @throws NullPointerException if the specified builder is null - * - @since 1.1 - */ - default JsonArrayBuilder addAll(JsonArrayBuilder builder) { - throw new UnsupportedOperationException(); - } - - /** - * Inserts a value to the array at the specified position. Shifts the value - * currently at that position (if any) and any subsequent values to the right - * (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the JSON value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, JsonValue value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a value to the array as a {@link JsonString} at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the string value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, String value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a value to the array as a {@link JsonNumber} at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, BigDecimal value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a value to the array as a {@link JsonNumber} at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, BigInteger value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a value to the array as a {@link JsonNumber} at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, int value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a value to the array as a {@link JsonNumber} at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, long value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a value to the array as a {@link JsonNumber} at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws NumberFormatException if the value is Not-a-Number (NaN) or - * infinity - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, double value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a {@link JsonValue#TRUE} or {@link JsonValue#FALSE} value to the - * array at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param value the boolean value - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, boolean value) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a {@link JsonValue#NULL} value to the array at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder addNull(int index) { - return add(index, JsonValue.NULL); - } - - /** - * Adds a {@link JsonObject} from an object builder to the array at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param builder the object builder - * @return this array builder - * @throws NullPointerException if the specified builder is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, JsonObjectBuilder builder) { - throw new UnsupportedOperationException(); - } - - /** - * Adds a {@link JsonArray} from an array builder to the array at the specified position. - * Shifts the value currently at that position (if any) and any subsequent values - * to the right (adds one to their indices). Index starts with 0. - * - * @param index the position in the array - * @param builder the array builder - * @return this array builder - * @throws NullPointerException if the specified builder is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index > array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder add(int index, JsonArrayBuilder builder) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value at the - * specified position. - * - * @param index the position in the array - * @param value the JSON value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, JsonValue value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonString} at the specified position. - * - * @param index the position in the array - * @param value the string value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, String value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonNumber} at the specified position. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, BigDecimal value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonNumber} at the specified position. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws NullPointerException if the specified value is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, BigInteger value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonNumber} at the specified position. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, int value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonNumber} at the specified position. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, long value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonNumber} at the specified position. - * - * @param index the position in the array - * @param value the number value - * @return this array builder - * @throws NumberFormatException if the value is Not-a-Number (NaN) or - * infinity - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @see JsonNumber - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, double value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with - * a {@link JsonValue#TRUE} or {@link JsonValue#FALSE} value - * at the specified position. - * - * @param index the position in the array - * @param value the boolean value - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, boolean value) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with - * a {@link JsonValue#NULL} value at the specified position. - * - * @param index the position in the array - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder setNull(int index) { - return set(index, JsonValue.NULL); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonObject} from an object builder at the specified position. - * - * @param index the position in the array - * @param builder the object builder - * @return this array builder - * @throws NullPointerException if the specified builder is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, JsonObjectBuilder builder) { - throw new UnsupportedOperationException(); - } - - /** - * Replaces a value in the array with the specified value as a - * {@link JsonArray} from an array builder at the specified position. - * - * @param index the position in the array - * @param builder the array builder - * @return this array builder - * @throws NullPointerException if the specified builder is null - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder set(int index, JsonArrayBuilder builder) { - throw new UnsupportedOperationException(); - } - - /** - * Remove the value in the array at the specified position. - * Shift any subsequent values to the left (subtracts one from their - * indices. - * - * @param index the position in the array - * @return this array builder - * @throws IndexOutOfBoundsException if the index is out of range - * {@code (index < 0 || index >= array size)} - * - * @since 1.1 - */ - default JsonArrayBuilder remove(int index) { - throw new UnsupportedOperationException(); - } - - /** - * Returns the current array. - * - * @return the current JSON array - */ - JsonArray build(); - -} - Index: trunk/src/javax/json/JsonBuilderFactory.java =================================================================== --- trunk/src/javax/json/JsonBuilderFactory.java (revision 14273) +++ (revision ) @@ -1,157 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2013-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; - -import java.util.Collection; -import java.util.Map; - -/** - * Factory to create {@link JsonObjectBuilder} and {@link JsonArrayBuilder} - * instances. If a factory instance is configured with some configuration, - * that would be used to configure the created builder instances. - * - *

- * {@code JsonObjectBuilder} and {@code JsonArrayBuilder} can also be created - * using {@link Json}'s methods. If multiple builder instances are created, - * then creating them using a builder factory is preferred. - * - *

- * For example: - * 

- * 
- * JsonBuilderFactory factory = Json.createBuilderFactory(...);
- * JsonArray value = factory.createArrayBuilder()
- *     .add(factory.createObjectBuilder()
- *         .add("type", "home")
- *         .add("number", "212 555-1234"))
- *     .add(factory.createObjectBuilder()
- *         .add("type", "fax")
- *         .add("number", "646 555-4567"))
- *     .build();
- * 
- *
- * - *

All the methods in this class are safe for use by multiple concurrent - * threads. - */ -public interface JsonBuilderFactory { - - /** - * Creates a {@code JsonObjectBuilder} instance that is used to build - * {@link JsonObject}. - * - * @return a JSON object builder - */ - JsonObjectBuilder createObjectBuilder(); - - /** - * Creates a {@code JsonObjectBuilder} instance, initialized with an object. - * - * @param object the initial object in the builder - * @return a JSON object builder - * @throws NullPointerException if specified object is {@code null} - * - * @since 1.1 - */ - default JsonObjectBuilder createObjectBuilder(JsonObject object) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a {@code JsonObjectBuilder} instance, initialized with the specified object. - * - * @param object the initial object in the builder - * @return a JSON object builder - * @throws NullPointerException if specified object is {@code null} - * - * @since 1.1 - */ - default JsonObjectBuilder createObjectBuilder(Map object) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a {@code JsonArrayBuilder} instance that is used to build - * {@link JsonArray} - * - * @return a JSON array builder - */ - JsonArrayBuilder createArrayBuilder(); - - /** - * Creates a {@code JsonArrayBuilder} instance, initialized with an array. - * - * @param array the initial array in the builder - * @return a JSON array builder - * @throws NullPointerException if specified array is {@code null} - * - * @since 1.1 - */ - default JsonArrayBuilder createArrayBuilder(JsonArray array) { - throw new UnsupportedOperationException(); - } - - /** - * Creates a {@code JsonArrayBuilder} instance, - * initialized with the content of specified collection. - * - * @param collection the initial data for the builder - * @return a JSON array builder - * @throws NullPointerException if specified collection is {@code null} - * - * @since 1.1 - */ - default JsonArrayBuilder createArrayBuilder(Collection collection) { - throw new UnsupportedOperationException(); - } - - /** - * Returns read-only map of supported provider specific configuration - * properties that are used to configure the created JSON builders. - * If there are any specified configuration properties that are not - * supported by the provider, they won't be part of the returned map. - * - * @return a map of supported provider specific properties that are used - * to configure the builders. The map be empty but not null. - */ - Map getConfigInUse(); - -} Index: trunk/src/javax/json/JsonException.java =================================================================== --- trunk/src/javax/json/JsonException.java (revision 14273) +++ (revision ) @@ -1,79 +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; - -/** - * JsonException indicates that some exception happened during - * JSON processing. - */ -public class JsonException extends RuntimeException { - - /** - * Constructs a new runtime exception with the specified detail message. - * The cause is not initialized, and may subsequently be initialized by a - * call to {@link #initCause}. - * - * @param message the detail message. The detail message is saved for - * later retrieval by the {@link #getMessage()} method. - */ - public JsonException(String message) { - super(message); - } - - /** - * Constructs a new runtime exception with the specified detail message and - * cause.

Note that the detail message associated with - * {@code cause} is not automatically incorporated in - * this runtime exception's detail message. - * - * @param message the detail message (which is saved for later retrieval - * by the {@link #getMessage()} method). - * @param cause the cause (which is saved for later retrieval by the - * {@link #getCause()} method). (A null value is - * permitted, and indicates that the cause is nonexistent or - * unknown.) - */ - public JsonException(String message, Throwable cause) { - super(message, cause); - } - -} - Index: trunk/src/javax/json/JsonMergePatch.java =================================================================== --- trunk/src/javax/json/JsonMergePatch.java (revision 14273) +++ (revision ) @@ -1,87 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2015-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; - -/** - *

This interface represents an implementation of a JSON Merge Patch - * as defined by RFC 7396. - *

- *

A {@code JsonMergePatch} can be instantiated with {@link Json#createMergePatch(JsonValue)} - * by specifying the patch operations in a JSON Merge Patch or using {@link Json#createMergeDiff(JsonValue, JsonValue)} - * to create a JSON Merge Patch based on the difference between two {@code JsonValue}s. - *

- * The following illustrates both approaches. - *

1. Construct a JsonMergePatch with an existing JSON Merge Patch. - * 

{@code
- *   JsonValue contacts = ... ; // The target to be patched
- *   JsonValue patch = ...  ; // JSON Merge Patch
- *   JsonMergePatch mergePatch = Json.createMergePatch(patch);
- *   JsonValue result = mergePatch.apply(contacts);
- * }
- * 2. Construct a JsonMergePatch from a difference between two {@code JsonValue}s. - * 
{@code
- *   JsonValue source = ... ; // The source object
- *   JsonValue target = ... ; // The modified object
- *   JsonMergePatch mergePatch = Json.createMergeDiff(source, target); // The diff between source and target in a Json Merge Patch format
- * }
- * - * @see RFC 7396 - * - * @since 1.1 - */ -public interface JsonMergePatch { - - /** - * Applies the JSON Merge Patch to the specified {@code target}. - * The target is not modified by the patch. - * - * @param target the target to apply the merge patch - * @return the transformed target after the patch - */ - JsonValue apply(JsonValue target); - - /** - * Returns the {@code JsonMergePatch} as {@code JsonValue}. - * - * @return this {@code JsonMergePatch} as {@code JsonValue} - */ - JsonValue toJsonValue(); -} Index: trunk/src/javax/json/JsonNumber.java =================================================================== --- trunk/src/javax/json/JsonNumber.java (revision 14273) +++ (revision ) @@ -1,210 +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; - -import java.math.BigDecimal; -import java.math.BigInteger; - -/** - * An immutable JSON number value. - * - *

- * Implementations may use a {@link BigDecimal} object to store the numeric - * value internally. - * The {@code BigDecimal} object can be constructed from the following types: - * int {@link BigDecimal#BigDecimal(int)}, - * long {@link BigDecimal#BigDecimal(long)}, - * BigInteger {@link BigDecimal#BigDecimal(BigInteger)}, - * double {@link BigDecimal#valueOf(double)}, and - * String {@link BigDecimal#BigDecimal(String)}. - * Some of the method semantics in this class are defined using the - * {@code BigDecimal} semantics. - */ -public interface JsonNumber extends JsonValue { - - /** - * Returns true if this JSON number is a integral number. This method - * semantics are defined using {@code bigDecimalValue().scale()}. If the - * scale is zero, then it is considered integral type. This integral type - * information can be used to invoke an appropriate accessor method to - * obtain a numeric value as in the following example: - * - * 

-     * 
-     * JsonNumber num = ...
-     * if (num.isIntegral()) {
-     *     num.longValue();     // or other methods to get integral value
-     * } else {
-     *     num.doubleValue();   // or other methods to get decimal number value
-     * }
-     * 
-     *
- * - * @return true if this number is a integral number, otherwise false - */ - boolean isIntegral(); - - /** - * Returns this JSON number as an {@code int}. Note that this conversion - * can lose information about the overall magnitude and precision of the - * number value as well as return a result with the opposite sign. - * - * @return an {@code int} representation of the JSON number - * @see java.math.BigDecimal#intValue() - */ - int intValue(); - - /** - * Returns this JSON number as an {@code int}. - * - * @return an {@code int} representation of the JSON number - * @throws ArithmeticException if the number has a nonzero fractional - * part or if it does not fit in an {@code int} - * @see java.math.BigDecimal#intValueExact() - */ - int intValueExact(); - - /** - * Returns this JSON number as a {@code long}. Note that this conversion - * can lose information about the overall magnitude and precision of the - * number value as well as return a result with the opposite sign. - * - * @return a {@code long} representation of the JSON number. - * @see java.math.BigDecimal#longValue() - */ - long longValue(); - - /** - * Returns this JSON number as a {@code long}. - * - * @return a {@code long} representation of the JSON number - * @throws ArithmeticException if the number has a non-zero fractional - * part or if it does not fit in a {@code long} - * @see java.math.BigDecimal#longValueExact() - */ - long longValueExact(); - - /** - * Returns this JSON number as a {@link BigInteger} object. This is a - * a convenience method for {@code bigDecimalValue().toBigInteger()}. - * Note that this conversion can lose information about the overall - * magnitude and precision of the number value as well as return a result - * with the opposite sign. - * - * @return a {@code BigInteger} representation of the JSON number. - * @see java.math.BigDecimal#toBigInteger() - */ - BigInteger bigIntegerValue(); - - /** - * Returns this JSON number as a {@link BigInteger} object. This is a - * convenience method for {@code bigDecimalValue().toBigIntegerExact()}. - * - * @return a {@link BigInteger} representation of the JSON number - * @throws ArithmeticException if the number has a nonzero fractional part - * @see java.math.BigDecimal#toBigIntegerExact() - */ - BigInteger bigIntegerValueExact(); - - /** - * Returns this JSON number as a {@code double}. This is a - * a convenience method for {@code bigDecimalValue().doubleValue()}. - * Note that this conversion can lose information about the overall - * magnitude and precision of the number value as well as return a result - * with the opposite sign. - * - * @return a {@code double} representation of the JSON number - * @see java.math.BigDecimal#doubleValue() - */ - double doubleValue(); - - /** - * Returns this JSON number as a {@link BigDecimal} object. - * - * @return a {@link BigDecimal} representation of the JSON number - */ - BigDecimal bigDecimalValue(); - - /** - * Returns this JSON number as a {@link Number} object. - * - * @return a {@link Number} representation of the JSON number - * - * @since 1.1 - */ - default Number numberValue() { - throw new UnsupportedOperationException(); - } - - /** - * Returns a JSON text representation of the JSON number. The - * representation is equivalent to {@link BigDecimal#toString()}. - * - * @return JSON text representation of the number - */ - @Override - String toString(); - - /** - * Compares the specified object with this {@code JsonNumber} object for - * equality. Returns {@code true} if and only if the type of the specified - * object is also {@code JsonNumber} and their {@link #bigDecimalValue()} - * objects are equal - * - * @param obj the object to be compared for equality with - * this {@code JsonNumber} - * @return {@code true} if the specified object is equal to this - * {@code JsonNumber} - */ - @Override - boolean equals(Object obj); - - /** - * Returns the hash code value for this {@code JsonNumber} object. The - * hash code of a {@code JsonNumber} object is defined as the hash code of - * its {@link #bigDecimalValue()} object. - * - * @return the hash code value for this {@code JsonNumber} object - */ - @Override - int hashCode(); - -} Index: trunk/src/javax/json/JsonObject.java =================================================================== --- trunk/src/javax/json/JsonObject.java (revision 14273) +++ (revision ) @@ -1,273 +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; - -import java.util.Map; - -/** - * {@code JsonObject} class represents an immutable JSON object value - * (an unordered collection of zero or more name/value pairs). - * It also provides unmodifiable map view to the JSON object - * name/value mappings. - * - *

A JsonObject instance can be created from an input source using - * {@link JsonReader#readObject()}. For example: - * 


- * JsonReader jsonReader = Json.createReader(...);
- * JsonObject object = jsonReader.readObject();
- * jsonReader.close();
- *
- * - * It can also be built from scratch using a {@link JsonObjectBuilder}. - * - *

For example 1: An empty JSON object can be built as follows: - * 


- * JsonObject object = Json.createObjectBuilder().build();
- *
- * - * For example 2: The following JSON - * 

- * {
- *     "firstName": "John", "lastName": "Smith", "age": 25,
- *     "address" : {
- *         "streetAddress": "21 2nd Street",
- *         "city": "New York",
- *         "state": "NY",
- *         "postalCode": "10021"
- *     },
- *     "phoneNumber": [
- *         { "type": "home", "number": "212 555-1234" },
- *         { "type": "fax", "number": "646 555-4567" }
- *     ]
- * }
- *
- * can be built using : - * 

- * JsonObject value = Json.createObjectBuilder()
- *     .add("firstName", "John")
- *     .add("lastName", "Smith")
- *     .add("age", 25)
- *     .add("address", Json.createObjectBuilder()
- *         .add("streetAddress", "21 2nd Street")
- *         .add("city", "New York")
- *         .add("state", "NY")
- *         .add("postalCode", "10021"))
- *     .add("phoneNumber", Json.createArrayBuilder()
- *         .add(Json.createObjectBuilder()
- *             .add("type", "home")
- *             .add("number", "212 555-1234"))
- *         .add(Json.createObjectBuilder()
- *             .add("type", "fax")
- *             .add("number", "646 555-4567")))
- *     .build();
- *
- * - * {@code JsonObject} can be written to JSON as follows: - * 

- * JsonWriter writer = ...
- * JsonObject obj = ...;
- * writer.writeObject(obj);
- *
- * - * {@code JsonObject} values can be {@link JsonObject}, {@link JsonArray}, - * {@link JsonString}, {@link JsonNumber}, {@link JsonValue#TRUE}, - * {@link JsonValue#FALSE}, {@link JsonValue#NULL}. These values can be - * accessed using various accessor methods. - * - *

In the above example 2, "John" can be got using - * 


- * String firstName = object.getString("firstName");
- *
- * - * This map object provides read-only access to the JSON object data, - * and attempts to modify the map, whether direct or via its collection - * views, result in an {@code UnsupportedOperationException}. - * - *

The map object's iteration ordering is based on the order in which - * name/value pairs are added to the corresponding builder or the order - * in which name/value pairs appear in the corresponding stream. - */ -public interface JsonObject extends JsonStructure, Map { - - /** - * Returns the array value to which the specified name is mapped. - * This is a convenience method for {@code (JsonArray)get(name)} to - * get the value. - * - * @param name the name whose associated value is to be returned - * @return the array value to which the specified name is mapped, or - * {@code null} if this object contains no mapping for the name - * @throws ClassCastException if the value to which the specified name - * is mapped is not assignable to JsonArray type - */ - JsonArray getJsonArray(String name); - - /** - * Returns the object value to which the specified name is mapped. - * This is a convenience method for {@code (JsonObject)get(name)} to - * get the value. - * - * @param name the name whose associated value is to be returned - * @return the object value to which the specified name is mapped, or - * {@code null} if this object contains no mapping for the name - * @throws ClassCastException if the value to which the specified name - * is mapped is not assignable to JsonObject type - */ - JsonObject getJsonObject(String name); - - /** - * Returns the number value to which the specified name is mapped. - * This is a convenience method for {@code (JsonNumber)get(name)} to - * get the value. - * - * @param name the name whose associated value is to be returned - * @return the number value to which the specified name is mapped, or - * {@code null} if this object contains no mapping for the name - * @throws ClassCastException if the value to which the specified name - * is mapped is not assignable to JsonNumber type - */ - JsonNumber getJsonNumber(String name); - - /** - * Returns the string value to which the specified name is mapped. - * This is a convenience method for {@code (JsonString)get(name)} to - * get the value. - * - * @param name the name whose associated value is to be returned - * @return the string value to which the specified name is mapped, or - * {@code null} if this object contains no mapping for the name - * @throws ClassCastException if the value to which the specified name - * is mapped is not assignable to JsonString type - */ - JsonString getJsonString(String name); - - /** - * A convenience method for - * {@code getJsonString(name).getString()} - * - * @param name whose associated value is to be returned as String - * @return the String value to which the specified name is mapped - * @throws NullPointerException if the specified name doesn't have any - * mapping - * @throws ClassCastException if the value for specified name mapping - * is not assignable to JsonString - */ - String getString(String name); - - /** - * Returns the string value of the associated {@code JsonString} mapping - * for the specified name. If {@code JsonString} is found, then its - * {@link javax.json.JsonString#getString()} is returned. Otherwise, - * the specified default value is returned. - * - * @param name whose associated value is to be returned as String - * @param defaultValue a default value to be returned - * @return the string value of the associated mapping for the name, - * or the default value - */ - String getString(String name, String defaultValue); - - /** - * A convenience method for - * {@code getJsonNumber(name).intValue()} - * - * @param name whose associated value is to be returned as int - * @return the int value to which the specified name is mapped - * @throws NullPointerException if the specified name doesn't have any - * mapping - * @throws ClassCastException if the value for specified name mapping - * is not assignable to JsonNumber - */ - int getInt(String name); - - /** - * Returns the int value of the associated {@code JsonNumber} mapping - * for the specified name. If {@code JsonNumber} is found, then its - * {@link javax.json.JsonNumber#intValue()} is returned. Otherwise, - * the specified default value is returned. - * - * @param name whose associated value is to be returned as int - * @param defaultValue a default value to be returned - * @return the int value of the associated mapping for the name, - * or the default value - */ - int getInt(String name, int defaultValue); - - /** - * Returns the boolean value of the associated mapping for the specified - * name. If the associated mapping is JsonValue.TRUE, then returns true. - * If the associated mapping is JsonValue.FALSE, then returns false. - * - * @param name whose associated value is to be returned as boolean - * @return the boolean value to which the specified name is mapped - * @throws NullPointerException if the specified name doesn't have any - * mapping - * @throws ClassCastException if the value for specified name mapping - * is not assignable to JsonValue.TRUE or JsonValue.FALSE - */ - boolean getBoolean(String name); - - /** - * Returns the boolean value of the associated mapping for the specified - * name. If the associated mapping is JsonValue.TRUE, then returns true. - * If the associated mapping is JsonValue.FALSE, then returns false. - * Otherwise, the specified default value is returned. - * - * @param name whose associated value is to be returned as int - * @param defaultValue a default value to be returned - * @return the boolean value of the associated mapping for the name, - * or the default value - */ - boolean getBoolean(String name, boolean defaultValue); - - /** - * Returns {@code true} if the associated value for the specified name is - * {@code JsonValue.NULL}. - * - * @param name name whose associated value is checked - * @return return true if the associated value is {@code JsonValue.NULL}, - * otherwise false - * @throws NullPointerException if the specified name doesn't have any - * mapping - */ - boolean isNull(String name); - -} Index: trunk/src/javax/json/JsonObjectBuilder.java =================================================================== --- trunk/src/javax/json/JsonObjectBuilder.java (revision 14273) +++ (revision ) @@ -1,307 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2013-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; - -import java.math.BigDecimal; -import java.math.BigInteger; - -/** - * A builder for creating {@link JsonObject} models from scratch. This - * interface initializes an empty JSON object model and provides methods to add - * name/value pairs to the object model and to return the resulting object. - * The methods in this class can be chained to add multiple name/value pairs - * to the object. - * - *

The class {@link javax.json.Json} contains methods to create the builder - * object. The example code below shows how to build an empty {@code JsonObject} - * instance. - * 

- * 
- * JsonObject object = Json.createObjectBuilder().build();
- * 
- *
- * - *

The class {@link JsonBuilderFactory} also contains methods to create - * {@code JsonObjectBuilder} instances. A factory instance can be used to create - * multiple builder instances with the same configuration. This the preferred - * way to create multiple instances. - * - * The example code below shows how to build a {@code JsonObject} model that - * represents the following JSON object: - * - * 

- * 
- * {
- *     "firstName": "John", "lastName": "Smith", "age": 25,
- *     "address" : {
- *         "streetAddress": "21 2nd Street",
- *         "city": "New York",
- *         "state": "NY",
- *         "postalCode": "10021"
- *     },
- *     "phoneNumber": [
- *         { "type": "home", "number": "212 555-1234" },
- *         { "type": "fax", "number": "646 555-4567" }
- *     ]
- * }
- * 
- *
- * - *

The code to create the object shown above is the following: - * - * 

- * 
- * JsonBuilderFactory factory = Json.createBuilderFactory(config);
- * JsonObject value = factory.createObjectBuilder()
- *     .add("firstName", "John")
- *     .add("lastName", "Smith")
- *     .add("age", 25)
- *     .add("address", factory.createObjectBuilder()
- *         .add("streetAddress", "21 2nd Street")
- *         .add("city", "New York")
- *         .add("state", "NY")
- *         .add("postalCode", "10021"))
- *     .add("phoneNumber", factory.createArrayBuilder()
- *         .add(factory.createObjectBuilder()
- *             .add("type", "home")
- *             .add("number", "212 555-1234"))
- *         .add(factory.createObjectBuilder()
- *             .add("type", "fax")
- *             .add("number", "646 555-4567")))
- *     .build();
- * 
- *
- * - *

This class does not allow null to be used as a name or - * value while building the JSON object - * - * @see JsonArrayBuilder - */ -public interface JsonObjectBuilder { - - /** - * Adds a name/{@code JsonValue} pair to the JSON object associated with - * this object builder. If the object contains a mapping for the specified - * name, this method replaces the old value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name or value is null - */ - JsonObjectBuilder add(String name, JsonValue value); - - /** - * Adds a name/{@code JsonString} pair to the JSON object associated with - * this object builder. If the object contains a mapping for the specified - * name, this method replaces the old value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name or value is null - */ - JsonObjectBuilder add(String name, String value); - - /** - * Adds a name/{@code JsonNumber} pair to the JSON object associated with - * this object builder. If the object contains a mapping for the specified - * name, this method replaces the old value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name or value is null - * - * @see JsonNumber - */ - JsonObjectBuilder add(String name, BigInteger value); - - /** - * Adds a name/{@code JsonNumber} pair to the JSON object associated with - * this object builder. If the object contains a mapping for the specified - * name, this method replaces the old value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name or value is null - * - * @see JsonNumber - */ - JsonObjectBuilder add(String name, BigDecimal value); - - /** - * Adds a name/{@code JsonNumber} pair to the JSON object associated with - * this object builder. If the object contains a mapping for the specified - * name, this method replaces the old value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name is null - * - * @see JsonNumber - */ - JsonObjectBuilder add(String name, int value); - - /** - * Adds a name/{@code JsonNumber} pair to the JSON object associated with - * this object builder. If the object contains a mapping for the specified - * name, this method replaces the old value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name is null - * - * @see JsonNumber - */ - JsonObjectBuilder add(String name, long value); - - /** - * Adds a name/{@code JsonNumber} pair to the JSON object associated with - * this object builder. If the object contains a mapping for the specified - * name, this method replaces the old value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NumberFormatException if the value is Not-a-Number (NaN) or - * infinity - * @throws NullPointerException if the specified name is null - * - * @see JsonNumber - */ - JsonObjectBuilder add(String name, double value); - - /** - * Adds a name/{@code JsonValue#TRUE} or name/{@code JsonValue#FALSE} pair - * to the JSON object associated with this object builder. If the object - * contains a mapping for the specified name, this method replaces the old - * value with the specified value. - * - * @param name name in the name/value pair - * @param value value in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name is null - */ - JsonObjectBuilder add(String name, boolean value); - - /** - * Adds a name/{@code JsonValue#NULL} pair to the JSON object associated - * with this object builder where the value is {@code null}. - * If the object contains a mapping for the specified name, this method - * replaces the old value with {@code null}. - * - * @param name name in the name/value pair - * @return this object builder - * @throws NullPointerException if the specified name is null - */ - JsonObjectBuilder addNull(String name); - - /** - * Adds a name/{@code JsonObject} pair to the JSON object associated - * with this object builder. The value {@code JsonObject} is built from the - * specified object builder. If the object contains a mapping for the - * specified name, this method replaces the old value with the - * {@code JsonObject} from the specified object builder. - * - * @param name name in the name/value pair - * @param builder the value is the object associated with this builder - * @return this object builder - * @throws NullPointerException if the specified name or builder is null - */ - JsonObjectBuilder add(String name, JsonObjectBuilder builder); - - /** - * Adds a name/{@code JsonArray} pair to the JSON object associated with - * this object builder. The value {@code JsonArray} is built from the - * specified array builder. If the object contains a mapping for the - * specified name, this method replaces the old value with the - * {@code JsonArray} from the specified array builder. - * - * @param name the name in the name/value pair - * @param builder the value is the object array with this builder - * @return this object builder - * @throws NullPointerException if the specified name or builder is null - */ - JsonObjectBuilder add(String name, JsonArrayBuilder builder); - - /** - * Adds all name/value pairs in the JSON object associated with the specified - * object builder to the JSON object associated with this object builder. - * The newly added name/value pair will replace any existing name/value pair with - * the same name. - * - * @param builder the specified object builder - * @return this object builder - * @throws NullPointerException if the specified builder is null - * @since 1.1 - */ - default JsonObjectBuilder addAll(JsonObjectBuilder builder) { - throw new UnsupportedOperationException(); - } - - /** - * Remove the name/value pair from the JSON object associated with this - * object builder if it is present. - * - * @param name the name in the name/value pair to be removed - * @return this object builder - * @throws NullPointerException if the specified name is null - * @since 1.1 - */ - default JsonObjectBuilder remove(String name) { - throw new UnsupportedOperationException(); - } - - /** - * Returns the JSON object associated with this object builder. - * The iteration order for the {@code JsonObject} is based - * on the order in which name/value pairs are added to the object using - * this builder. - * - * @return JSON object that is being built - */ - JsonObject build(); - -} Index: trunk/src/javax/json/JsonPatch.java =================================================================== --- trunk/src/javax/json/JsonPatch.java (revision 14273) +++ (revision ) @@ -1,163 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2015-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; - -/** - *

This interface represents an immutable implementation of a JSON Patch - * as defined by RFC 6902. - *

- *

A {@code JsonPatch} can be instantiated with {@link Json#createPatch(JsonArray)} - * by specifying the patch operations in a JSON Patch. Alternately, it - * can also be constructed with a {@link JsonPatchBuilder}. - *

- * The following illustrates both approaches. - *

1. Construct a JsonPatch with a JSON Patch. - * 

{@code
- *   JsonArray contacts = ... // The target to be patched
- *   JsonArray patch = ...  ; // JSON Patch
- *   JsonPatch jsonpatch = Json.createPatch(patch);
- *   JsonArray result = jsonpatch.apply(contacts);
- * }
- * 2. Construct a JsonPatch with JsonPatchBuilder. - * 
{@code
- *   JsonPatchBuilder builder = Json.createPatchBuilder();
- *   JsonArray result = builder.add("/John/phones/office", "1234-567")
- *                             .remove("/Amy/age")
- *                             .build()
- *                             .apply(contacts);
- * }
- * - * @see RFC 6902 - * - * @since 1.1 - */ -public interface JsonPatch { - - /** - * This enum represents the list of valid JSON Patch operations - * as defined by RFC 6902. - * - * @see RFC 6902 - */ - enum Operation { - - /** - * "add" operation. - */ - ADD("add"), - - /** - * "remove" operation. - */ - REMOVE("remove"), - - /** - * "remove" operation. - */ - REPLACE("replace"), - - /** - * "move" operation. - */ - MOVE("move"), - - /** - * "copy" operation. - */ - COPY("copy"), - - /** - * "test" operation. - */ - TEST("test"); - - private final String operationName; - - private Operation(String operationName) { - this.operationName = operationName; - } - - /** - * Returns enum constant name as lower case string. - * - * @return lower case name of the enum constant - */ - public String operationName() { - return operationName; - } - - /** - * Returns the enum constant with the specified name. - * - * @param operationName {@code operationName} to convert to the enum constant. - * @return the enum constant for given {@code operationName} - * @throws JsonException if given {@code operationName} is not recognized - */ - public static Operation fromOperationName(String operationName) { - for (Operation op : values()) { - if (op.operationName().equalsIgnoreCase(operationName)) { - return op; - } - } - throw new JsonException("Illegal value for the operationName of the JSON patch operation: " + operationName); - } - } - - /** - * Applies the patch operations to the specified {@code target}. - * The target is not modified by the patch. - * - * @param the target type, must be a subtype of {@link JsonStructure} - * @param target the target to apply the patch operations - * @return the transformed target after the patch - * @throws JsonException if the supplied JSON Patch is malformed or if - * it contains references to non-existing members - */ - T apply(T target); - - /** - * Returns the {@code JsonPatch} as {@code JsonArray}. - * - * @return this {@code JsonPatch} as {@code JsonArray} - */ - JsonArray toJsonArray(); - -} Index: trunk/src/javax/json/JsonPatchBuilder.java =================================================================== --- trunk/src/javax/json/JsonPatchBuilder.java (revision 14273) +++ (revision ) @@ -1,210 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2015-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; - -/** - * A builder for constructing a JSON Patch as defined by - * RFC 6902 by adding - * JSON Patch operations incrementally. - *

- * The following illustrates the approach. - * 

- *   JsonPatchBuilder builder = Json.createPatchBuilder();
- *   JsonPatch patch = builder.add("/John/phones/office", "1234-567")
- *                            .remove("/Amy/age")
- *                            .build();
- *
- * The result is equivalent to the following JSON Patch. - * 
- * [
- *    {"op" = "add", "path" = "/John/phones/office", "value" = "1234-567"},
- *    {"op" = "remove", "path" = "/Amy/age"}
- * ]
- * - * @see RFC 6902 - * - * @since 1.1 - */ -public interface JsonPatchBuilder { - - /** - * Adds an "add" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder add(String path, JsonValue value); - - /** - * Adds an "add" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder add(String path, String value); - - /** - * Adds an "add" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder add(String path, int value); - - /** - * Adds an "add" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder add(String path, boolean value); - - /** - * Adds a "remove" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer. - * @return this JsonPatchBuilder - */ - JsonPatchBuilder remove(String path); - - /** - * Adds a "replace" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder replace(String path, JsonValue value); - - /** - * Adds a "replace" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder replace(String path, String value); - - /** - * Adds a "replace" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder replace(String path, int value); - - /** - * Adds a "replace" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder replace(String path, boolean value); - - /** - * Adds a "move" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param from the "from" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder move(String path, String from); - - /** - * Adds a "copy" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param from the "from" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder copy(String path, String from); - - /** - * Adds a "test" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder test(String path, JsonValue value); - - /** - * Adds a "test" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder test(String path, String value); - - /** - * Adds a "test" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder test(String path, int value); - - /** - * Adds a "test" JSON Patch operation. - * - * @param path the "path" member of the operation. Must be a valid escaped JSON-Pointer string. - * @param value the "value" member of the operation - * @return this JsonPatchBuilder - */ - JsonPatchBuilder test(String path, boolean value); - - - /** - * Returns the JSON Patch. - * - * @return a JSON Patch - */ - JsonPatch build(); - -} Index: trunk/src/javax/json/JsonPointer.java =================================================================== --- trunk/src/javax/json/JsonPointer.java (revision 14273) +++ (revision ) @@ -1,140 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2015-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; - -/** - *

This interface represents an immutable implementation of a JSON Pointer - * as defined by RFC 6901. - *

- *

A JSON Pointer, when applied to a target {@link JsonValue}, - * defines a reference location in the target.

- *

An empty JSON Pointer string defines a reference to the target itself.

- *

If the JSON Pointer string is non-empty, it must be a sequence - * of '/' prefixed tokens, and the target must either be a {@link JsonArray} - * or {@link JsonObject}. If the target is a {@code JsonArray}, the pointer - * defines a reference to an array element, and the last token specifies the index. - * If the target is a {@link JsonObject}, the pointer defines a reference to a - * name/value pair, and the last token specifies the name. - *

- *

The method {@link #getValue getValue()} returns the referenced value. - * Methods {@link #add add()}, {@link #replace replace()}, - * and {@link #remove remove()} execute operations specified in - * RFC 6902.

- * - * @see RFC 6901 - * @see RFC 6902 - * - * @since 1.1 - */ -public interface JsonPointer { - - /** - * Adds or replaces a value at the referenced location in the specified - * {@code target} with the specified {@code value}. - *
    - *
  1. If the reference is the target (empty JSON Pointer string), - * the specified {@code value}, which must be the same type as - * specified {@code target}, is returned.
    2. - *
  2. If the reference is an array element, the specified {@code value} is inserted - * into the array, at the referenced index. The value currently at that location, and - * any subsequent values, are shifted to the right (adds one to the indices). - * Index starts with 0. If the reference is specified with a "-", or if the - * index is equal to the size of the array, the value is appended to the array.
    3. - *
  3. If the reference is a name/value pair of a {@code JsonObject}, and the - * referenced value exists, the value is replaced by the specified {@code value}. - * If the value does not exist, a new name/value pair is added to the object.
    4. - *
- * - * @param the target type, must be a subtype of {@link JsonValue} - * @param target the target referenced by this {@code JsonPointer} - * @param value the value to be added - * @return the transformed {@code target} after the value is added. - * @throws NullPointerException if {@code target} is {@code null} - * @throws JsonException if the reference is an array element and - * the index is out of range ({@code index < 0 || index > array size}), - * or if the pointer contains references to non-existing objects or arrays. - */ - T add(T target, JsonValue value); - - /** - * Removes the value at the reference location in the specified {@code target}. - * - * @param the target type, must be a subtype of {@link JsonValue} - * @param target the target referenced by this {@code JsonPointer} - * @return the transformed {@code target} after the value is removed. - * @throws NullPointerException if {@code target} is {@code null} - * @throws JsonException if the referenced value does not exist, - * or if the reference is the target. - */ - T remove(T target); - - /** - * Replaces the value at the referenced location in the specified - * {@code target} with the specified {@code value}. - * - * @param the target type, must be a subtype of {@link JsonValue} - * @param target the target referenced by this {@code JsonPointer} - * @param value the value to be stored at the referenced location - * @return the transformed {@code target} after the value is replaced. - * @throws NullPointerException if {@code target} is {@code null} - * @throws JsonException if the referenced value does not exist, - * or if the reference is the target. - */ - T replace(T target, JsonValue value); - - /** - * Returns {@code true} if there is a value at the referenced location in the specified {@code target}. - * - * @param target the target referenced by this {@code JsonPointer} - * @return {@code true} if this pointer points to a value in a specified {@code target}. - */ - boolean containsValue(JsonStructure target); - - /** - * Returns the value at the referenced location in the specified {@code target}. - * - * @param target the target referenced by this {@code JsonPointer} - * @return the referenced value in the target. - * @throws NullPointerException if {@code target} is null - * @throws JsonException if the referenced value does not exist - */ - JsonValue getValue(JsonStructure target); -} Index: trunk/src/javax/json/JsonReader.java =================================================================== --- trunk/src/javax/json/JsonReader.java (revision 14273) +++ (revision ) @@ -1,157 +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. - */ - -package javax.json; - -import java.io.Closeable; - -/** - * Reads a JSON {@link JsonObject object} or an {@link JsonArray array} - * structure from an input source. - * - *

The class {@link javax.json.Json} contains methods to create readers from - * input sources ({@link java.io.InputStream} and {@link java.io.Reader}). - * - *

- * The following example demonstrates how to read an empty JSON array from - * a string: - * 

- * 
- * JsonReader jsonReader = Json.createReader(new StringReader("[]"));
- * JsonArray array = jsonReader.readArray();
- * jsonReader.close();
- * 
- *
- * - *

- * The class {@link JsonReaderFactory} also contains methods to create - * {@code JsonReader} instances. A factory instance can be used to create - * multiple reader instances with the same configuration. This the preferred - * way to create multiple instances. A sample usage is shown in the following - * example: - * 

- * 
- * JsonReaderFactory factory = Json.createReaderFactory(config);
- * JsonReader reader1 = factory.createReader(...);
- * JsonReader reader2 = factory.createReader(...);
- * 
- *
- */ -public interface JsonReader extends /*Auto*/Closeable { - - /** - * Returns a JSON array or object that is represented in - * the input source. This method needs to be called - * only once for a reader instance. - * - * @return a JSON object or array - * @throws JsonException if a JSON object or array cannot - * be created due to i/o error (IOException would be - * cause of JsonException) - * @throws javax.json.stream.JsonParsingException if a JSON object or array - * cannot be created due to incorrect representation - * @throws IllegalStateException if read, readObject, readArray, - * readValue or close method is already called - */ - JsonStructure read(); - - /** - * Returns a JSON object that is represented in - * the input source. This method needs to be called - * only once for a reader instance. - * - * @return a JSON object - * @throws JsonException if a JSON object cannot - * be created due to i/o error (IOException would be - * cause of JsonException) - * @throws javax.json.stream.JsonParsingException if a JSON object cannot - * be created due to incorrect representation - * @throws IllegalStateException if read, readObject, readArray, - * readValue or close method is already called - */ - JsonObject readObject(); - - /** - * Returns a JSON array that is represented in - * the input source. This method needs to be called - * only once for a reader instance. - * - * @return a JSON array - * @throws JsonException if a JSON array cannot - * be created due to i/o error (IOException would be - * cause of JsonException) - * @throws javax.json.stream.JsonParsingException if a JSON array cannot - * be created due to incorrect representation - * @throws IllegalStateException if read, readObject, readArray, - * readValue or close method is already called - */ - JsonArray readArray(); - - /** - * Returns a JSON value that is represented in - * the input source. This method needs to be called - * only once for a reader instance. - * - * @return a JSON value - * @throws JsonException if a JSON value - * be created due to i/o error (IOException would be - * cause of JsonException) - * @throws javax.json.stream.JsonParsingException if a JSON value - * cannot be created due to incorrect representation - * @throws IllegalStateException if read, readObject, readArray, - * readValue or close method is already called - * - * @since 1.1 - */ - default JsonValue readValue() { - throw new UnsupportedOperationException(); - } - - /** - * Closes this reader and frees any resources associated with the - * reader. This method closes the underlying input source. - * - * @throws JsonException if an i/o error occurs (IOException would be - * cause of JsonException) - */ - @Override - void close(); - -} Index: trunk/src/javax/json/JsonReaderFactory.java =================================================================== --- trunk/src/javax/json/JsonReaderFactory.java (revision 14273) +++ (revision ) @@ -1,115 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2013-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; - -import java.io.InputStream; -import java.io.Reader; -import java.nio.charset.Charset; -import java.util.Map; - -/** - * Factory to create {@link javax.json.JsonReader} instances. If a factory - * instance is configured with some configuration, that would be - * used to configure the created reader instances. - * - *

- * {@link javax.json.JsonReader} can also be created using {@link Json}'s - * {@code createReader} methods. If multiple reader instances are created, - * then creating them using a reader factory is preferred. - * - *

- * For example: - * 

- * 
- * JsonReaderFactory factory = Json.createReaderFactory(...);
- * JsonReader reader1 = factory.createReader(...);
- * JsonReader reader2 = factory.createReader(...);
- * 
- *
- * - *

All the methods in this class are safe for use by multiple concurrent - * threads. - */ -public interface JsonReaderFactory { - - /** - * Creates a JSON reader from a character stream. The reader is configured - * with the factory configuration. - * - * @param reader a reader from which JSON is to be read - * @return a JSON reader - */ - 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. - * The reader is configured with the factory configuration. - * - * @param in a byte stream from which JSON is to be read - * @return a JSON reader - */ - JsonReader createReader(InputStream in); - - /** - * Creates a JSON reader from a byte stream. The bytes of the stream - * are decoded to characters using the specified charset. The reader is - * configured with the factory configuration. - * - * @param in a byte stream from which JSON is to be read - * @param charset a charset - * @return a JSON reader - */ - JsonReader createReader(InputStream in, Charset charset); - - /** - * Returns read-only map of supported provider specific configuration - * properties that are used to configure the created JSON readers. - * If there are any specified configuration properties that are not - * supported by the provider, they won't be part of the returned map. - * - * @return a map of supported provider specific properties that are used - * to configure the readers. The map be empty but not null. - */ - Map getConfigInUse(); - -} Index: trunk/src/javax/json/JsonString.java =================================================================== --- trunk/src/javax/json/JsonString.java (revision 14273) +++ (revision ) @@ -1,87 +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; - -/** - * An immutable JSON string value. - */ -public interface JsonString extends JsonValue { - - /** - * Returns the JSON string value. - * - * @return a JSON string value - */ - String getString(); - - - /** - * Returns the char sequence for the JSON String value - * - * @return a char sequence for the JSON String value - */ - CharSequence getChars(); - - /** - * Compares the specified object with this {@code JsonString} for equality. - * Returns {@code true} if and only if the specified object is also a - * {@code JsonString}, and their {@link #getString()} objects are - * equal. - * - * @param obj the object to be compared for equality with this - * {@code JsonString} - * @return {@code true} if the specified object is equal to this - * {@code JsonString} - */ - @Override - boolean equals(Object obj); - - /** - * Returns the hash code value for this {@code JsonString} object. - * The hash code of a {@code JsonString} object is defined to be its - * {@link #getString()} object's hash code. - * - * @return the hash code value for this {@code JsonString} object - */ - @Override - int hashCode(); - -} Index: trunk/src/javax/json/JsonStructure.java =================================================================== --- trunk/src/javax/json/JsonStructure.java (revision 14273) +++ (revision ) @@ -1,62 +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. - */ - -package javax.json; - -/** - * Super type for the two structured types in JSON ({@link JsonObject object}s - * and {@link JsonArray array}s). - */ -public interface JsonStructure extends JsonValue { - - /** - * Get the value referenced by the provided JSON Pointer in the JsonStructure. - * - * @param jsonPointer the JSON Pointer - * @return the {@code JsonValue} at the referenced location - * @throws JsonException if the JSON Pointer is malformed, or if it references - * a non-existing member or value. - * - * @since 1.1 - */ - default public JsonValue getValue(String jsonPointer) { - return Json.createPointer(jsonPointer).getValue(this); - } -} Index: trunk/src/javax/json/JsonValue.java =================================================================== --- trunk/src/javax/json/JsonValue.java (revision 14273) +++ (revision ) @@ -1,164 +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; - -/** - * JsonValue represents an immutable JSON value. - * - * - *

A JSON value is one of the following: - * an object ({@link JsonObject}), an array ({@link JsonArray}), - * a number ({@link JsonNumber}), a string ({@link JsonString}), - * {@code true} ({@link JsonValue#TRUE JsonValue.TRUE}), {@code false} - * ({@link JsonValue#FALSE JsonValue.FALSE}), - * or {@code null} ({@link JsonValue#NULL JsonValue.NULL}). - */ -public interface JsonValue { - - /** - * The empty JSON object. - * - * @since 1.1 - */ - static final JsonObject EMPTY_JSON_OBJECT = new EmptyObject(); - - /** - * The empty JSON array. - * - * @since 1.1 - */ - static final JsonArray EMPTY_JSON_ARRAY = new EmptyArray(); - - /** - * Indicates the type of a {@link JsonValue} object. - */ - enum ValueType { - /** - * JSON array. - */ - ARRAY, - - /** - * JSON object. - */ - OBJECT, - - /** - * JSON string. - */ - STRING, - - /** - * JSON number. - */ - NUMBER, - - /** - * JSON true. - */ - TRUE, - - /** - * JSON false. - */ - FALSE, - - /** - * JSON null. - */ - NULL - } - - /** - * JSON null value. - */ - static final JsonValue NULL = new JsonValueImpl(ValueType.NULL); - - /** - * JSON true value. - */ - static final JsonValue TRUE = new JsonValueImpl(ValueType.TRUE); - - /** - * JSON false value. - */ - static final JsonValue FALSE = new JsonValueImpl(ValueType.FALSE); - - /** - * Returns the value type of this JSON value. - * - * @return JSON value type - */ - ValueType getValueType(); - - /** - * Return the JsonValue as a JsonObject - * - * @return the JsonValue as a JsonObject - * @throws ClassCastException if the JsonValue is not a JsonObject - * - * @since 1.1 - */ - default JsonObject asJsonObject() { - return JsonObject.class.cast(this); - } - - /** - * Return the JsonValue as a JsonArray - * - * @return the JsonValue as a JsonArray - * @throws ClassCastException if the JsonValue is not a JsonArray - * - * @since 1.1 - */ - default JsonArray asJsonArray() { - return JsonArray.class.cast(this); - } - - /** - * Returns JSON text for this JSON value. - * - * @return JSON text - */ - @Override - String toString(); - -} Index: trunk/src/javax/json/JsonValueImpl.java =================================================================== --- trunk/src/javax/json/JsonValueImpl.java (revision 14273) +++ (revision ) @@ -1,107 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2016-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; - -import java.io.Serializable; - -/** - * Private implementation of {@link JsonValue} for simple {@link ValueType}s - * allowing their usage in constants which are better to implement {@link Serializable}. - * - * @author Lukas Jungmann - */ -final class JsonValueImpl implements JsonValue, Serializable { - - private final ValueType valueType; - - JsonValueImpl(ValueType valueType) { - this.valueType = valueType; - } - - /** - * Returns the value type of this JSON value. - * - * @return JSON value type - */ - @Override - public ValueType getValueType() { - return valueType; - } - - /** - * Compares the specified object with this {@link JsonValue} - * object for equality. Returns {@code true} if and only if the - * specified object is also a JsonValue, and their - * {@link #getValueType()} objects are equal. - * - * @param obj the object to be compared for equality with this JsonValue - * @return {@code true} if the specified object is equal to this - * JsonValue - */ - @Override - public boolean equals(Object obj) { - if (this == obj) { - return true; - } - if (obj instanceof JsonValue) { - return getValueType() == ((JsonValue) obj).getValueType(); - } - return false; - } - - /** - * Returns the hash code value for this {@link JsonValue} object. - * The hash code of the {@link JsonValue} object is defined to be - * its {@link #getValueType()} object's hash code. - * - * @return the hash code value for this {@link JsonValue} object - */ - @Override - public int hashCode() { - return valueType.hashCode(); - } - - @Override - public String toString() { - return valueType.name().toLowerCase(); - } - -} Index: trunk/src/javax/json/JsonWriter.java =================================================================== --- trunk/src/javax/json/JsonWriter.java (revision 14273) +++ (revision ) @@ -1,147 +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. - */ - -package javax.json; - -import java.io.Closeable; - -/** - * Writes a JSON {@link JsonObject object} or {@link JsonArray array} structure - * to an output source. - * - *

The class {@link javax.json.Json} contains methods to create writers from - * output sources ({@link java.io.OutputStream} and {@link java.io.Writer}). - * - *

- * The following example demonstrates how write an empty JSON object: - * 

- * 
- * JsonWriter jsonWriter = Json.createWriter(...);
- * jsonWriter.writeObject(Json.createObjectBuilder().build());
- * jsonWriter.close();
- * 
- *
- * - *

- * The class {@link JsonWriterFactory} also contains methods to create - * {@code JsonWriter} instances. A factory instance can be used to create - * multiple writer instances with the same configuration. This the preferred - * way to create multiple instances. A sample usage is shown in the following - * example: - * 

- * 
- * JsonWriterFactory factory = Json.createWriterFactory(config);
- * JsonWriter writer1 = factory.createWriter(...);
- * JsonWriter writer2 = factory.createWriter(...);
- * 
- *
- */ -public interface JsonWriter extends /*Auto*/Closeable { - - /** - * Writes the specified JSON {@link JsonArray array} to the output - * source. This method needs to be called only once for a writer instance. - * - * @param array JSON array that is to be written to the output source - * @throws JsonException if the specified JSON object cannot be - * written due to i/o error (IOException would be cause of - * JsonException) - * @throws IllegalStateException if writeArray, writeObject, write or close - * method is already called - */ - void writeArray(JsonArray array); - - /** - * Writes the specified JSON {@link JsonObject object} to the output - * source. This method needs to be called only once for a writer instance. - * - * @param object JSON object that is to be written to the output source - * @throws JsonException if the specified JSON object cannot be - * written due to i/o error (IOException would be cause of JsonException) - * @throws IllegalStateException if writeArray, writeObject, write or close - * method is already called - */ - void writeObject(JsonObject object); - - /** - * Writes the specified JSON {@link JsonObject object} or - * {@link JsonArray array} to the output source. This method needs - * to be called only once for a writer instance. - * - * @param value JSON array or object that is to be written to the output - * source - * @throws JsonException if the specified JSON object cannot be - * written due to i/o error (IOException would be cause of - * JsonException) - * @throws IllegalStateException if writeArray, writeObject, write - * or close method is already called - */ - void write(JsonStructure value); - - /** - * Closes this JSON writer and frees any resources associated with the - * writer. This method closes the underlying output source. - * - * @throws JsonException if an i/o error occurs (IOException would be - * cause of JsonException) - */ - - /** - * Writes the specified {@link JsonValue} to the output source. - * method needs to be called only once for a write instance. - * - * @param value a {@code JsonValue} to be written to the output - * source - * @throws JsonException if the specified JSON object cannot be - * written due to i/o error (IOException would be cause of - * JsonException) - * @throws IllegalStateException if writeArray, writeObject, write - * or close method is already called - * - * @since 1.1 - */ - default void write(JsonValue value) { - throw new UnsupportedOperationException(); - } - - @Override - void close(); - -} Index: trunk/src/javax/json/JsonWriterFactory.java =================================================================== --- trunk/src/javax/json/JsonWriterFactory.java (revision 14273) +++ (revision ) @@ -1,118 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2013-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; - -import java.io.OutputStream; -import java.io.Writer; -import java.nio.charset.Charset; -import java.util.Map; - -/** - * Factory to create {@link javax.json.JsonWriter} instances. If a factory - * instance is configured with some configuration, that would be - * used to configure the created writer instances. - * - *

- * {@link javax.json.JsonWriter} can also be created using {@link Json}'s - * {@code createWriter} methods. If multiple writer instances are created, - * then creating them using a writer factory is preferred. - * - *

- * For example: - * 

- * 
- * JsonWriterFactory factory = Json.createWriterFactory(...);
- * JsonWriter writer1 = factory.createWriter(...);
- * JsonWriter writer2 = factory.createWriter(...);
- * 
- *
- * - *

All the methods in this class are safe for use by multiple concurrent - * threads. - */ -public interface JsonWriterFactory { - - /** - * Creates a JSON writer to write a JSON {@link JsonObject object} or - * {@link JsonArray array} structure to the specified character stream. - * The writer is configured with the factory configuration. - * - * @param writer to which JSON object or array is written - * @return a JSON writer - */ - 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. The writer is configured with the factory configuration. - * - * @param out to which JSON object or array is written - * @return a JSON writer - */ - JsonWriter createWriter(OutputStream out); - - /** - * 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 the - * specified charset. The writer is configured with the factory - * configuration. - * - * @param out to which JSON object or array is written - * @param charset a charset - * @return a JSON writer - */ - JsonWriter createWriter(OutputStream out, Charset charset); - - /** - * Returns read-only map of supported provider specific configuration - * properties that are used to configure the created JSON writer objects. - * If there are any specified configuration properties that are not - * supported by the provider, they won't be part of the returned map. - * - * @return a map of supported provider specific properties that are used - * to configure the created writers. The map may be empty but not null. - */ - Map getConfigInUse(); - -} Index: trunk/src/javax/json/package-info.java =================================================================== --- trunk/src/javax/json/package-info.java (revision 14273) +++ (revision ) @@ -1,69 +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. - */ - -/** - * Provides an object model API to process JSON. - * - *

The object model API is a high-level API that provides immutable object - * models for JSON object and array structures. These JSON structures are - * represented as object models using the Java types {@link javax.json.JsonObject} - * and {@link javax.json.JsonArray}. The interface {@code javax.json.JsonObject} provides - * a {@link java.util.Map} view to access the unordered collection of zero or - * more name/value pairs from the model. Similarly, the interface - * {@code JsonArray} provides a {@link java.util.List} view to access the - * ordered sequence of zero or more values from the model. - * - *

The object model API uses builder patterns to create and modify - * these object models. The classes {@link javax.json.JsonObjectBuilder} and - * {@link javax.json.JsonArrayBuilder} provide methods to create and modify models - * of type {@code JsonObject} and {@code JsonArray} respectively. - * - *

These object models can also be created from an input source using - * the class {@link javax.json.JsonReader}. Similarly, these object models - * can be written to an output source using the class {@link javax.json.JsonWriter}. - *

- * This package includes several classes that implement other JSON related - * standards: JSON Pointer, - * JSON Patch, and - * JSON Merge Patch. - * They can be used to retrieve, transform or manipulate values in an - * object model. - */ -package javax.json; Index: trunk/src/javax/json/spi/JsonProvider.java =================================================================== --- trunk/src/javax/json/spi/JsonProvider.java (revision 14273) +++ (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. - *

    - *
  • An empty {@code jsonPointer} string defines a reference to the target itself.
    • - *
  • If the {@code jsonPointer} string is non-empty, it must be a sequence of '{@code /}' prefixed tokens.
    • - *
- * - * @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 14273) +++ (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; Index: trunk/src/javax/json/stream/JsonCollectors.java =================================================================== --- trunk/src/javax/json/stream/JsonCollectors.java (revision 14273) +++ (revision ) @@ -1,184 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2015-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.stream; - -import java.util.Map; -import java.util.HashMap; -import java.util.stream.Collector; -import java.util.function.BinaryOperator; -import java.util.function.Function; -import java.util.function.BiConsumer; - -import javax.json.Json; -import javax.json.JsonArray; -import javax.json.JsonArrayBuilder; -import javax.json.JsonObject; -import javax.json.JsonObjectBuilder; -import javax.json.JsonValue; -import javax.json.JsonException; - -/** - * This class contains some implementations of {@code java.util.stream.Collector} for accumulating - * {@link JsonValue}s into {@link JsonArray} and {@link JsonObject}. - * - * @since 1.1 - */ - -public final class JsonCollectors { - - private JsonCollectors() { - } - - /** - * Constructs a {@code java.util.stream.Collector} that accumulates the input {@code JsonValue} - * elements into a {@code JsonArray}. - * - * @return the constructed Collector - */ - public static Collector toJsonArray() { - return Collector.of( - Json::createArrayBuilder, - JsonArrayBuilder::add, - JsonArrayBuilder::addAll, - JsonArrayBuilder::build); - } - - /** - * Constructs a {@code java.util.stream.Collector} that accumulates the input {@code Map.Entry} - * elements into a {@code JsonObject}. - * - * @return the constructed Collector - */ - public static Collector, JsonObjectBuilder, JsonObject> toJsonObject() { - return Collector.of( - Json::createObjectBuilder, - (JsonObjectBuilder b, Map.Entry v) -> b.add(v.getKey(), v.getValue()), - JsonObjectBuilder::addAll, - JsonObjectBuilder::build); - } - - /** - * Constructs a {@code java.util.stream.Collector} that accumulates the input {@code JsonValue} - * elements into a {@code JsonObject}. The name/value pairs of the {@code JsonObject} are computed - * by applying the provided mapping functions. - * - * @param keyMapper a mapping function to produce names. - * @param valueMapper a mapping function to produce values - * @return the constructed Collector - */ - public static Collector - toJsonObject(Function keyMapper, - Function valueMapper) { - return Collector.of( - Json::createObjectBuilder, - (b, v) -> b.add(keyMapper.apply(v), valueMapper.apply(v)), - JsonObjectBuilder::addAll, - JsonObjectBuilder::build, - Collector.Characteristics.UNORDERED); - } - - /** - * Constructs a {@code java.util.stream.Collector} that implements a "group by" operation on the - * input {@code JsonValue} elements. A classifier function maps the input {@code JsonValue}s to keys, and - * the {@code JsonValue}s are partitioned into groups according to the value of the key. - * A reduction operation is performed on the {@code JsonValue}s in each group, using the - * downstream {@code Collector}. For each group, the key and the results of the reduction operation - * become the name/value pairs of the resultant {@code JsonObject}. - * - * @param the intermediate accumulation {@code JsonArrayBuilder} of the downstream collector - * @param classifier a function mapping the input {@code JsonValue}s to a String, producing keys - * @param downstream a {@code Collector} that implements a reduction operation on the - * {@code JsonValue}s in each group. - * @return the constructed {@code Collector} - */ - public static Collector, JsonObject> - groupingBy(Function classifier, - Collector downstream) { - - BiConsumer, JsonValue> accumulator = - (map, value) -> { - String key = classifier.apply(value); - if (key == null) { - throw new JsonException("element cannot be mapped to a null key"); - } - // Build a map of key to JsonArrayBuilder - T arrayBuilder = - map.computeIfAbsent(key, v->downstream.supplier().get()); - // Add elements from downstream Collector to the arrayBuilder. - downstream.accumulator().accept(arrayBuilder, value); - }; - Function, JsonObject> finisher = - map -> { - // transform the map of name: JsonArrayBuilder to - // name: JsonArray - // using the downstream collector for reducing the JsonArray - JsonObjectBuilder objectBuilder = Json.createObjectBuilder(); - map.forEach((k, v) -> { - JsonArray array = downstream.finisher().apply(v); - objectBuilder.add(k, array); - }); - return objectBuilder.build(); - }; - BinaryOperator> combiner = - (map1, map2) -> { - map1.putAll(map2); - return map1; - }; - return Collector.of(HashMap::new, accumulator, combiner, finisher, - Collector.Characteristics.UNORDERED); - } - - /** - * Constructs a {@code java.util.stream.Collector} that implements a "group by" operation on the - * input {@code JsonValue} elements. A classifier function maps the input {@code JsonValue}s to keys, and - * the {@code JsonValue}s are partitioned into groups according to the value of the key. - * The {@code JsonValue}s in each group are added to a {@code JsonArray}. The key and the - * {@code JsonArray} in each group becomes the name/value pair of the resultant {@code JsonObject}. - * - * @param classifier a function mapping the input {@code JsonValue}s to a String, producing keys - * @return the constructed {@code Collector} - */ - public static Collector, JsonObject> - groupingBy(Function classifier) { - return groupingBy(classifier, toJsonArray()); - } -} - Index: trunk/src/javax/json/stream/JsonGenerationException.java =================================================================== --- trunk/src/javax/json/stream/JsonGenerationException.java (revision 14273) +++ (revision ) @@ -1,81 +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. - */ - -package javax.json.stream; - -import javax.json.JsonException; - -/** - * {@code JsonGenerationException} indicates an incorrect JSON is - * being generated. - */ -public class JsonGenerationException extends JsonException { - - /** - * Constructs a new runtime exception with the specified detail message. - * The cause is not initialized, and may subsequently be initialized by a - * call to {@link #initCause}. - * - * @param message the detail message. The detail message is saved for - * later retrieval by the {@link #getMessage()} method. - */ - public JsonGenerationException(String message) { - super(message); - } - - /** - * Constructs a new runtime exception with the specified detail message and - * cause.

Note that the detail message associated with - * {@code cause} is not automatically incorporated in - * this runtime exception's detail message. - * - * @param message the detail message (which is saved for later retrieval - * by the {@link #getMessage()} method). - * @param cause the cause (which is saved for later retrieval by the - * {@link #getCause()} method). (A null value is - * permitted, and indicates that the cause is nonexistent or - * unknown.) - */ - public JsonGenerationException(String message, Throwable cause) { - super(message, cause); - } - -} - Index: trunk/src/javax/json/stream/JsonGenerator.java =================================================================== --- trunk/src/javax/json/stream/JsonGenerator.java (revision 14273) +++ (revision ) @@ -1,563 +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.stream; - -import javax.json.JsonValue; -import java.io.Closeable; -import java.io.Flushable; -import java.math.BigDecimal; -import java.math.BigInteger; - -/** - * Writes JSON data to an output source in a streaming way. The class - * {@link javax.json.Json} contains methods to create generators for character - * or output streams ({@link java.io.Writer} and {@link java.io.OutputStream}). - * - *

- * The following example shows how to create a JSON generator: - * 

- * 
- * JsonGenerator generator = Json.createGenerator(...);
- * 
- *
- * - *

- * The class {@link JsonGeneratorFactory} also contains methods to create - * {@code JsonGenerator} instances. {@link JsonGeneratorFactory} should be used - * when creating multiple generator instances, as in the following example: - * 

- * 
- * JsonGeneratorFactory factory = Json.createGeneratorFactory();
- * JsonGenerator generator1 = factory.createGenerator(...);
- * JsonGenerator generator2 = factory.createGenerator(...);
- * 
- *
- * - *

- * JSON objects can be created using {@code JsonGenerator} by calling the - * {@link #writeStartObject()} method and then adding name/value pairs with the - * {@code write} method. - *

- * The following example shows how to generate an empty JSON object: - * 

- * 
- * JsonGenerator generator = ...;
- * generator.writeStartObject().writeEnd().close();
- * 
- *
- * - * JSON arrays can be created using {@code JsonGenerator} by calling the - * {@link #writeStartArray()} method and then adding values with the - * {@code write} method. - * - *

- * The following example shows how to generate an empty JSON array: - * 

- * 
- * JsonGenerator generator = ...;
- * generator.writeStartArray().writeEnd().close();
- * 
- *
- * - *

- * Other JSON values (that are not JSON objects or arrays) can be created - * by calling the appropriate {@code write} methods. - *

- * The following example shows how to generate a JSON string: - * 


- * JsonGenerator generator = ...;
- * generator.write("message").close();
- *
- * - * {@code JsonGenerator} methods can be chained as in the following example: - * 
- * 
- * generator
- *     .writeStartObject()
- *         .write("firstName", "John")
- *         .write("lastName", "Smith")
- *         .write("age", 25)
- *         .writeStartObject("address")
- *             .write("streetAddress", "21 2nd Street")
- *             .write("city", "New York")
- *             .write("state", "NY")
- *             .write("postalCode", "10021")
- *         .writeEnd()
- *         .writeStartArray("phoneNumber")
- *             .writeStartObject()
- *                 .write("type", "home")
- *                 .write("number", "212 555-1234")
- *             .writeEnd()
- *             .writeStartObject()
- *                 .write("type", "fax")
- *                 .write("number", "646 555-4567")
- *             .writeEnd()
- *         .writeEnd()
- *     .writeEnd();
- * generator.close();
- * 
- *
- * - * The example code above generates the following JSON (or equivalent): - * 
- * 
- * {
- *   "firstName": "John", "lastName": "Smith", "age": 25,
- *   "address" : {
- *       "streetAddress": "21 2nd Street",
- *       "city": "New York",
- *       "state": "NY",
- *       "postalCode": "10021"
- *   },
- *   "phoneNumber": [
- *       {"type": "home", "number": "212 555-1234"},
- *       {"type": "fax", "number": "646 555-4567"}
- *    ]
- * }
- * 
- *
- * - * The generated JSON text must strictly conform to the grammar defined in - * RFC 7159. - * - * @see javax.json.Json - * @see JsonGeneratorFactory - */ -public interface JsonGenerator extends Flushable, /*Auto*/Closeable { - /** - * Configuration property to generate JSON prettily. All providers - * must support this property. The value of the property could be - * be anything. - */ - String PRETTY_PRINTING = "javax.json.stream.JsonGenerator.prettyPrinting" ; - - /** - * Writes the JSON start object character. It starts a new child object - * context within which JSON name/value pairs can be written to the object. - * This method is valid only in an array context, field context or in no context (when a - * context is not yet started). This method can only be called once in - * no context. - * - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is called within an - * object context or if it is called more than once in no context. - */ - JsonGenerator writeStartObject(); - - /** - * Writes the JSON name/start object character pair in the current - * object context. It starts a new child object context within which JSON - * name/value pairs can be written to the object. - * - * @param name a name within the JSON name/object pair to be written - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context - */ - JsonGenerator writeStartObject(String name); - - /** - * Writes the JSON name with a colon. It starts a field context, in which valid - * options are writing a value, starting an object or an array. - * - * Writing value closes field context, if object or array is started after field name, - * field context will be closed after object/array close. - * - * @param name name of json field - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context - * - * @since 1.1 - */ - JsonGenerator writeKey(String name); - - /** - * Writes the JSON start array character. It starts a new child array - * context within which JSON values can be written to the array. This - * method is valid only in an array context, field context or in no context (when a - * context is not yet started). This method can only be called once in - * no context. - * - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is called within an - * object context or if called more than once in no context - */ - JsonGenerator writeStartArray(); - - /** - * Writes the JSON name/start array character pair with in the current - * object context. It starts a new child array context within which JSON - * values can be written to the array. - * - * @param name a name within the JSON name/array pair to be written - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within - * an object context - */ - JsonGenerator writeStartArray(String name); - - /** - * Writes a JSON name/value pair in the current object context. - * - * @param name a name in the JSON name/value pair to be written in - * current JSON object - * @param value a value in the JSON name/value pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context - */ - JsonGenerator write(String name, JsonValue value); - - /** - * Writes a JSON name/string value pair in the current object context. - * The specified value is written as JSON string value. - * - * @param name a name in the JSON name/string pair to be written in - * current JSON object - * @param value a value in the JSON name/string pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context - */ - JsonGenerator write(String name, String value); - - /** - * Writes a JSON name/number value pair in the current object context. - * The specified value is written as a JSON number value. The string - * {@code new BigDecimal(value).toString()} - * is used as the text value for writing. - * - * @param name a name in the JSON name/number pair to be written in - * current JSON object - * @param value a value in the JSON name/number pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context. - */ - JsonGenerator write(String name, BigInteger value); - - /** - * Writes a JSON name/number value pair in the current object context. - * The specified value is written as a JSON number value. The specified - * value's {@code toString()} is used as the text value for writing. - * - * @param name a name in the JSON name/number pair to be written in - * current JSON object - * @param value a value in the JSON name/number pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context. - */ - JsonGenerator write(String name, BigDecimal value); - - /** - * Writes a JSON name/number value pair in the current object context. - * The specified value is written as a JSON number value. The string - * {@code new BigDecimal(value).toString()} is used as the text value - * for writing. - * - * @param name a name in the JSON name/number pair to be written in - * current JSON object - * @param value a value in the JSON name/number pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context. - */ - JsonGenerator write(String name, int value); - - /** - * Writes a JSON name/number value pair in the current object context. - * The specified value is written as a JSON number value. The string - * {@code new BigDecimal(value).toString()} is used as the text - * value for writing. - * - * @param name a name in the JSON name/number pair to be written in - * current JSON object - * @param value a value in the JSON name/number pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context. - */ - JsonGenerator write(String name, long value); - - /** - * Writes a JSON name/number value pair in the current object context. - * The specified value is written as a JSON number value. The string - * {@code BigDecimal.valueOf(double).toString()} - * is used as the text value for writing. - * - * @param name a name in the JSON name/number pair to be written in - * current JSON object - * @param value a value in the JSON name/number pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws NumberFormatException if the value is Not-a-Number (NaN) or infinity. - * @throws JsonGenerationException if this method is not called within an - * object context - */ - JsonGenerator write(String name, double value); - - /** - * Writes a JSON name/boolean value pair in the current object context. - * If value is true, it writes the JSON {@code true} value, otherwise - * it writes the JSON {@code false} value. - * - * @param name a name in the JSON name/boolean pair to be written in - * current JSON object - * @param value a value in the JSON name/boolean pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context. - */ - JsonGenerator write(String name, boolean value); - - - /** - * Writes a JSON name/null value pair in an current object context. - * - * @param name a name in the JSON name/null pair to be written in - * current JSON object - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * object context - */ - JsonGenerator writeNull(String name); - - /** - * Writes the end of the current context. If the current context is - * an array context, this method writes the end-of-array character (']'). - * If the current context is an object context, this method writes the - * end-of-object character ('}'). After writing the end of the current - * context, the parent context becomes the new current context. - * If parent context is field context, it is closed. - * - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is called in no context. - */ - JsonGenerator writeEnd(); - - /** - * Writes the specified value as a JSON value within - * the current array, field or root context. - * - * @param value a value to be written in current JSON array - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - */ - JsonGenerator write(JsonValue value); - - /** - * Writes the specified value as a JSON string value within - * the current array, field or root context. - * - * @param value a value to be written in current JSON array - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - */ - JsonGenerator write(String value); - - /** - * Writes the specified value as a JSON number value within - * the current array, field or root context. The specified value's {@code toString()} - * is used as the the text value for writing. - * - * @param value a value to be written in current JSON array - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - * - * @see javax.json.JsonNumber - */ - JsonGenerator write(BigDecimal value); - - /** - * Writes the specified value as a JSON number value within - * the current array, field or root context. The string {@code new BigDecimal(value).toString()} - * is used as the text value for writing. - * - * @param value a value to be written in current JSON array - * @return this generator. - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - * - * @see javax.json.JsonNumber - */ - JsonGenerator write(BigInteger value); - - /** - * Writes the specified value as a JSON number value within - * the current array, field or root context. The string {@code new BigDecimal(value).toString()} - * is used as the text value for writing. - * - * @param value a value to be written in current JSON array - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - */ - JsonGenerator write(int value); - - /** - * Writes the specified value as a JSON number value within - * the current array, field or root context. The string {@code new BigDecimal(value).toString()} - * is used as the text value for writing. - * - * @param value a value to be written in current JSON array - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - */ - JsonGenerator write(long value); - - /** - * Writes the specified value as a JSON number value within the current - * array, field or root context. The string {@code BigDecimal.valueOf(value).toString()} - * is used as the text value for writing. - * - * @param value a value to be written in current JSON array - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - * @throws NumberFormatException if the value is Not-a-Number (NaN) or infinity. - */ - JsonGenerator write(double value); - - /** - * Writes a JSON true or false value within the current array, field or root context. - * If value is true, this method writes the JSON {@code true} value, - * otherwise it writes the JSON {@code false} value. - * - * @param value a {@code boolean} value - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - */ - JsonGenerator write(boolean value); - - /** - * Writes a JSON null value within the current array, field or root context. - * - * @return this generator - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if this method is not called within an - * array or root context. - */ - JsonGenerator writeNull(); - - /** - * Closes this generator and frees any resources associated with it. - * This method closes the underlying output source. - * - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonGenerationException if an incomplete JSON is generated - */ - @Override - void close(); - - /** - * Flushes the underlying output source. If the generator has saved - * any characters in a buffer, writes them immediately to the underlying - * output source before flushing it. - * - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - */ - @Override - void flush(); - -} Index: trunk/src/javax/json/stream/JsonGeneratorFactory.java =================================================================== --- trunk/src/javax/json/stream/JsonGeneratorFactory.java (revision 14273) +++ (revision ) @@ -1,113 +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.stream; - -import java.io.OutputStream; -import java.io.Writer; -import java.nio.charset.Charset; -import java.util.Map; - -/** - * Factory to create {@link JsonGenerator} instances. If a factory - * instance is configured with some configuration, the configuration applies - * to all generator instances created using that factory instance. - * - *

- * The class {@link javax.json.Json Json} also provides methods to create - * {@link JsonGenerator} instances, but using {@code JsonGeneratorFactory} is - * preferred when creating multiple generator instances as shown in the - * following example: - * - * 

- * 
- * JsonGeneratorFactory factory = Json.createGeneratorFactory();
- * JsonGenerator generator1 = factory.createGenerator(...);
- * JsonGenerator generator2 = factory.createGenerator(...);
- * 
- *
- * - *

All the methods in this class are safe for use by multiple concurrent - * threads. - */ -public interface JsonGeneratorFactory { - - /** - * Creates a JSON generator to write JSON text to a character stream. - * The generator is configured with the factory configuration. - * - * @param writer i/o writer to which JSON is written - * @return the created JSON generator - */ - JsonGenerator createGenerator(Writer writer); - - /** - * Creates a JSON generator to write JSON text to a byte stream. Characters - * written to the stream are encoded into bytes using UTF-8 encoding. - * The generator is configured with the factory's configuration. - * - * @param out i/o stream to which JSON is written - * @return the created JSON generator - */ - JsonGenerator createGenerator(OutputStream out); - - /** - * Creates a JSON generator to write JSON text to a byte stream. Characters - * written to the stream are encoded into bytes using the specified charset. - * The generator is configured with the factory's configuration. - * - * @param out i/o stream to which JSON is written - * @param charset a charset - * @return the created JSON generator - */ - JsonGenerator createGenerator(OutputStream out, Charset charset); - - /** - * Returns a read-only map of supported provider specific configuration - * properties that are used to configure the JSON generators. - * If there are any specified configuration properties that are not - * supported by the provider, they won't be part of the returned map. - * - * @return a map of supported provider specific properties that are used - * to configure the created generators. The map may be empty but not null - */ - Map getConfigInUse(); - -} Index: trunk/src/javax/json/stream/JsonLocation.java =================================================================== --- trunk/src/javax/json/stream/JsonLocation.java (revision 14273) +++ (revision ) @@ -1,85 +1,0 @@ -/* - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. - * - * Copyright (c) 2013-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.stream; - -/** - * Provides the location information of a JSON event in an input source. The - * {@code JsonLocation} information can be used to identify incorrect JSON - * or can be used by higher frameworks to know about the processing location. - * - *

All the information provided by a {@code JsonLocation} is optional. For - * example, a provider may only report line numbers. Also, there may not be any - * location information for an input source. For example, if a - * {@code JsonParser} is created using - * {@link javax.json.JsonArray JsonArray} input source, all the methods in - * this class return -1. - * @see JsonParser - * @see JsonParsingException - */ -public interface JsonLocation { - - /** - * Return the line number (starts with 1 for the first line) for the current JSON event in the input source. - * - * @return the line number (starts with 1 for the first line) or -1 if none is available - */ - long getLineNumber(); - - /** - * Return the column number (starts with 1 for the first column) for the current JSON event in the input source. - * - * @return the column number (starts with 1 for the first column) or -1 if none is available - */ - long getColumnNumber(); - - /** - * Return the stream offset into the input source this location - * is pointing to. If the input source is a file or a byte stream then - * this is the byte offset into that stream, but if the input source is - * a character media then the offset is the character offset. - * Returns -1 if there is no offset available. - * - * @return the offset of input source stream, or -1 if there is - * no offset available - */ - long getStreamOffset(); - -} Index: trunk/src/javax/json/stream/JsonParser.java =================================================================== --- trunk/src/javax/json/stream/JsonParser.java (revision 14273) +++ (revision ) @@ -1,511 +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.stream; - - -import java.io.Closeable; -import java.math.BigDecimal; -import java.util.stream.Stream; -import java.util.Map; - -import javax.json.JsonValue; -import javax.json.JsonObject; -import javax.json.JsonArray; - -/** - * Provides forward, read-only access to JSON data in a streaming way. This - * is the most efficient way for reading JSON data. - * This is the only way to parse and process JSON data that are too big to be loaded in memory. - *

The class - * {@link javax.json.Json} contains methods to create parsers from input - * sources ({@link java.io.InputStream} and {@link java.io.Reader}). - * - *

- * The following example demonstrates how to create a parser from a string - * that contains an empty JSON array: - * 

- * 
- * JsonParser parser = Json.createParser(new StringReader("[]"));
- * 
- *
- * - *

- * The class {@link JsonParserFactory} also contains methods to create - * {@code JsonParser} instances. {@link JsonParserFactory} is preferred - * when creating multiple parser instances. A sample usage is shown - * in the following example: - * 

- * 
- * JsonParserFactory factory = Json.createParserFactory();
- * JsonParser parser1 = factory.createParser(...);
- * JsonParser parser2 = factory.createParser(...);
- * 
- *
- * - *

- * {@code JsonParser} parses JSON using the pull parsing programming model. - * In this model the client code controls the thread and calls the method - * {@code next()} to advance the parser to the next state after - * processing each element. The parser can generate the following events: - * {@code START_OBJECT}, {@code END_OBJECT}, {@code START_ARRAY}, - * {@code END_ARRAY}, {@code KEY_NAME}, {@code VALUE_STRING}, - * {@code VALUE_NUMBER}, {@code VALUE_TRUE}, {@code VALUE_FALSE}, - * and {@code VALUE_NULL}. - * - *

- * For example, for an empty JSON object ({ }), the parser generates the event - * {@code START_OBJECT} with the first call to the method {@code next()} and the - * event {@code END_OBJECT} with the second call to the method {@code next()}. - * The following code demonstrates how to access these events: - * - * 

- * 
- * Event event = parser.next(); // START_OBJECT
- * event = parser.next();       // END_OBJECT
- * 
- *
- * - *

- * For example, for the following JSON: - * 

- * {
- *   "firstName": "John", "lastName": "Smith", "age": 25,
- *   "phoneNumber": [
- *       { "type": "home", "number": "212 555-1234" },
- *       { "type": "fax", "number": "646 555-4567" }
- *    ]
- * }
- *
- * - *

calls to the method {@code next()} result in parse events at the specified - * locations below (marked in bold): - * - * 

- * {START_OBJECT
- *   "firstName"KEY_NAME: "John"VALUE_STRING, "lastName"KEY_NAME: "Smith"VALUE_STRING, "age"KEY_NAME: 25VALUE_NUMBER,
- *   "phoneNumber"KEY_NAME : [START_ARRAY
- *       {START_OBJECT "type"KEY_NAME: "home"VALUE_STRING, "number"KEY_NAME: "212 555-1234"VALUE_STRING }END_OBJECT,
- *       {START_OBJECT "type"KEY_NAME: "fax"VALUE_STRING, "number"KEY_NAME: "646 555-4567"VALUE_STRING }END_OBJECT
- *    ]END_ARRAY
- * }END_OBJECT
- *
- * - * The methods {@link #next()} and {@link #hasNext()} enable iteration over - * parser events to process JSON data. {@code JsonParser} provides get methods - * to obtain the value at the current state of the parser. For example, the - * following code shows how to obtain the value "John" from the JSON above: - * - * 
- * 
- * Event event = parser.next(); // START_OBJECT
- * event = parser.next();       // KEY_NAME
- * event = parser.next();       // VALUE_STRING
- * parser.getString();          // "John"
- * 
- *
- * - * Starting in version 1.1, it is possible to build a partial JSON object - * model from the stream, at the current parser position. - * The methods {@link #getArray} and {@link #getObject} can be used to read in - * a {@code JsonArray} or {@code JsonObject}. For example, the following code - * shows how to obtain the phoneNumber in a JsonArray, from the JSON above: - * - * 

- * while (parser.hasNext() {
- *     Event event = parser.next();
- *     if (event == JsonParser.Event.KEY_NAME ) {
- *         String key = getString();
- *         event = parser.next();
- *         if (key.equals("phoneNumber") {
- *             JsonArray phones = parser.getArray();
- *         }
- *     }
- * }
- *
- * - * The methods {@link #getArrayStream} and {@link #getObjectStream} can be used - * to get a stream of the elements of a {@code JsonArray} or {@code JsonObject}. - * For example, the following code shows another way to obtain John's phoneNumber - * in a {@code JsonArray} : - * - * 
{@code
- * Event event = parser.next(); // START_OBJECT
- * JsonArray phones = (JsonArray)
- *     parser.getObjectStream().filter(e->e.getKey().equals("phoneNumber"))
- *                             .map(e->e.getValue())
- *                             .findFirst()
- *                             .get();
- * }
- * - * The methods {@link #skipArray} and {@link #skipObject} can be used to - * skip tokens and position the parser to {@code END_ARRAY} or - * {@code END_OBJECT}. - *

- * {@code JsonParser} can be used to parse sequence of JSON values that are not - * enclosed in a JSON array, e.g. { } { }. The following code demonstrates how - * to parse such sequence. - * 


- * JsonParser parser = Json.createParser(...);
- * while (parser.hasNext) {
- *     parser.next(); // advance parser state
- *     JsonValue value = parser.getValue();
- * }
- *
- * - * @see javax.json.Json - * @see JsonParserFactory - */ -public interface JsonParser extends /*Auto*/Closeable { - - /** - * An event from {@code JsonParser}. - */ - enum Event { - /** - * Start of a JSON array. The position of the parser is after '['. - */ - START_ARRAY, - /** - * Start of a JSON object. The position of the parser is after '{'. - */ - START_OBJECT, - /** - * Name in a name/value pair of a JSON object. The position of the parser - * is after the key name. The method {@link #getString} returns the key - * name. - */ - KEY_NAME, - /** - * String value in a JSON array or object. The position of the parser is - * after the string value. The method {@link #getString} - * returns the string value. - */ - VALUE_STRING, - /** - * Number value in a JSON array or object. The position of the parser is - * after the number value. {@code JsonParser} provides the following - * methods to access the number value: {@link #getInt}, - * {@link #getLong}, and {@link #getBigDecimal}. - */ - VALUE_NUMBER, - /** - * {@code true} value in a JSON array or object. The position of the - * parser is after the {@code true} value. - */ - VALUE_TRUE, - /** - * {@code false} value in a JSON array or object. The position of the - * parser is after the {@code false} value. - */ - VALUE_FALSE, - /** - * {@code null} value in a JSON array or object. The position of the - * parser is after the {@code null} value. - */ - VALUE_NULL, - /** - * End of a JSON object. The position of the parser is after '}'. - */ - END_OBJECT, - /** - * End of a JSON array. The position of the parser is after ']'. - */ - END_ARRAY - } - - /** - * Returns {@code true} if there are more parsing states. This method returns - * {@code false} if the parser reaches the end of the JSON text. - * - * @return {@code true} if there are more parsing states. - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonParsingException if the parser encounters invalid JSON - * when advancing to next state. - */ - boolean hasNext(); - - /** - * Returns the event for the next parsing state. - * - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - * @throws JsonParsingException if the parser encounters invalid JSON - * when advancing to next state. - * @throws java.util.NoSuchElementException if there are no more parsing - * states. - * @return the event for the next parsing state - */ - Event next(); - - /** - * Returns a {@code String} for the name in a name/value pair, - * for a string value or a number value. This method should only be called - * when the parser state is {@link Event#KEY_NAME}, {@link Event#VALUE_STRING}, - * or {@link Event#VALUE_NUMBER}. - * - * @return a name when the parser state is {@link Event#KEY_NAME} - * a string value when the parser state is {@link Event#VALUE_STRING} - * a number value when the parser state is {@link Event#VALUE_NUMBER} - * @throws IllegalStateException when the parser state is not - * {@code KEY_NAME}, {@code VALUE_STRING}, or {@code VALUE_NUMBER} - */ - String getString(); - - /** - * Returns true if the JSON number at the current parser state is a - * integral number. A {@link BigDecimal} may be used to store the value - * internally and this method semantics are defined using its - * {@code scale()}. If the scale is zero, then it is considered integral - * type. This integral type information can be used to invoke an - * appropriate accessor method to obtain a numeric value as in the - * following example: - * - * 
-     * 
-     * JsonParser parser = ...
-     * if (parser.isIntegralNumber()) {
-     *     parser.getInt();     // or other methods to get integral value
-     * } else {
-     *     parser.getBigDecimal();
-     * }
-     * 
-     *
- * - * @return true if this number is a integral number, otherwise false - * @throws IllegalStateException when the parser state is not - * {@code VALUE_NUMBER} - */ - boolean isIntegralNumber(); - - /** - * Returns a JSON number as an integer. The returned value is equal - * to {@code new BigDecimal(getString()).intValue()}. Note that - * this conversion can lose information about the overall magnitude - * and precision of the number value as well as return a result with - * the opposite sign. This method should only be called when the parser - * state is {@link Event#VALUE_NUMBER}. - * - * @return an integer for a JSON number - * @throws IllegalStateException when the parser state is not - * {@code VALUE_NUMBER} - * @see java.math.BigDecimal#intValue() - */ - int getInt(); - - /** - * Returns a JSON number as a long. The returned value is equal - * to {@code new BigDecimal(getString()).longValue()}. Note that this - * conversion can lose information about the overall magnitude and - * precision of the number value as well as return a result with - * the opposite sign. This method is only called when the parser state is - * {@link Event#VALUE_NUMBER}. - * - * @return a long for a JSON number - * @throws IllegalStateException when the parser state is not - * {@code VALUE_NUMBER} - * @see java.math.BigDecimal#longValue() - */ - long getLong(); - - /** - * Returns a JSON number as a {@code BigDecimal}. The {@code BigDecimal} - * is created using {@code new BigDecimal(getString())}. This - * method should only called when the parser state is - * {@link Event#VALUE_NUMBER}. - * - * @return a {@code BigDecimal} for a JSON number - * @throws IllegalStateException when the parser state is not - * {@code VALUE_NUMBER} - */ - BigDecimal getBigDecimal(); - - /** - * Return the location that corresponds to the parser's current state in - * the JSON input source. The location information is only valid in the - * current parser state (or until the parser is advanced to a next state). - * - * @return a non-null location corresponding to the current parser state - * in JSON input source - */ - JsonLocation getLocation(); - - /** - * Returns a {@code JsonObject} and advances the parser to the - * corresponding {@code END_OBJECT}. - * - * @return the {@code JsonObject} at the current parser position - * - * @throws IllegalStateException when the parser state is not - * {@code START_OBJECT} - * - * @since 1.1 - */ - default public JsonObject getObject() { - throw new UnsupportedOperationException(); - } - - /** - * Returns a {@code JsonValue} at the current parser position. - * If the parser state is {@code START_ARRAY}, the behavior is - * the same as {@link #getArray}. If the parser state is - * {@code START_OBJECT}, the behavior is the same as - * {@link #getObject}. For all other cases, if applicable, the JSON value is - * read and returned. - * - * @return the {@code JsonValue} at the current parser position. - * @throws IllegalStateException when the parser state is - * {@code END_OBJECT} or {@code END_ARRAY} - * - * @since 1.1 - */ - default public JsonValue getValue() { - throw new UnsupportedOperationException(); - } - - /** - * Returns a {@code JsonArray} and advance the parser to the - * the corresponding {@code END_ARRAY}. - * - * @return the {@code JsonArray} at the current parser position - * - * @throws IllegalStateException when the parser state is not - * {@code START_ARRAY} - * - * @since 1.1 - */ - default public JsonArray getArray() { - throw new UnsupportedOperationException(); - } - - /** - * Returns a stream of the {@code JsonArray} elements. - * The parser state must be {@code START_ARRAY}. - * The elements are read lazily, on an as-needed basis, as - * required by the stream operations. - * If the stream operations do not consume - * all of the array elements, {@link skipArray} can be used to - * skip the unprocessed array elements. - * - * @return a stream of elements of the {@code JsonArray} - * - * @throws IllegalStateException when the parser state is not - * {@code START_ARRAY} - * - * @since 1.1 - */ - default public Stream getArrayStream() { - throw new UnsupportedOperationException(); - } - - /** - * Returns a stream of the {@code JsonObject}'s - * name/value pairs. The parser state must be {@code START_OBJECT}. - * The name/value pairs are read lazily, on an as-needed basis, as - * required by the stream operations. - * If the stream operations do not consume - * all of the object's name/value pairs, {@link skipObject} can be - * used to skip the unprocessed elements. - * - * @return a stream of name/value pairs of the {@code JsonObject} - * - * @throws IllegalStateException when the parser state is not - * {@code START_OBJECT} - * - * @since 1.1 - */ - default public Stream> getObjectStream() { - throw new UnsupportedOperationException(); - } - - /** - * Returns a stream of {@code JsonValue} from a sequence of - * JSON values. The values are read lazily, on an as-needed basis, - * as needed by the stream operations. - * - * @return a Stream of {@code JsonValue} - * - * @throws IllegalStateException if the parser is in an array or object. - * - * @since 1.1 - */ - default public Stream getValueStream() { - throw new UnsupportedOperationException(); - } - - /** - * Advance the parser to {@code END_ARRAY}. - * If the parser is in array context, i.e. it has previously - * encountered a {@code START_ARRAY} without encountering the - * corresponding {@code END_ARRAY}, the parser is advanced to - * the corresponding {@code END_ARRAY}. - * If the parser is not in any array context, nothing happens. - * - * @since 1.1 - */ - default public void skipArray() { - throw new UnsupportedOperationException(); - } - - /** - * Advance the parser to {@code END_OBJECT}. - * If the parser is in object context, i.e. it has previously - * encountered a {@code START_OBJECT} without encountering the - * corresponding {@code END_OBJECT}, the parser is advanced to - * the corresponding {@code END_OBJECT}. - * If the parser is not in any object context, nothing happens. - * - * @since 1.1 - */ - default public void skipObject() { - throw new UnsupportedOperationException(); - } - - /** - * Closes this parser and frees any resources associated with the - * parser. This method closes the underlying input source. - * - * @throws javax.json.JsonException if an i/o error occurs (IOException - * would be cause of JsonException) - */ - @Override - void close(); -} Index: trunk/src/javax/json/stream/JsonParserFactory.java =================================================================== --- trunk/src/javax/json/stream/JsonParserFactory.java (revision 14273) +++ (revision ) @@ -1,132 +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.stream; - -import javax.json.JsonArray; -import javax.json.JsonObject; -import java.io.InputStream; -import java.io.Reader; -import java.nio.charset.Charset; -import java.util.Map; - -/** - * Factory for creating {@link JsonParser} instances. If a factory - * instance is configured with a configuration, the configuration applies - * to all parser instances created using that factory instance. - * - *

- * The class {@link javax.json.Json Json} also provides methods to create - * {@link JsonParser} instances, but using {@code JsonParserFactory} is - * preferred when creating multiple parser instances as shown in the following - * example: - * - * 

- * 
- * JsonParserFactory factory = Json.createParserFactory();
- * JsonParser parser1 = factory.createParser(...);
- * JsonParser parser2 = factory.createParser(...);
- * 
- *
- * - *

All the methods in this class are safe for use by multiple concurrent - * threads. - */ -public interface JsonParserFactory { - - /** - * Creates a JSON parser from a character stream. - * - * @param reader a i/o reader from which JSON is to be read - * @return the created JSON parser - */ - JsonParser createParser(Reader reader); - - /** - * Creates a JSON parser from the specified byte stream. - * The character encoding of the stream is determined - * as specified in RFC 7159. - * - * @param in i/o stream from which JSON is to be read - * @return the created JSON parser - * @throws javax.json.JsonException if encoding cannot be determined - * or i/o error (IOException would be cause of JsonException) - */ - JsonParser createParser(InputStream in); - - /** - * Creates a JSON parser from the specified byte stream. - * The bytes of the stream are decoded to characters using the - * specified charset. - * - * @param in i/o stream from which JSON is to be read - * @param charset a charset - * @return the created JSON parser - */ - JsonParser createParser(InputStream in, Charset charset); - - /** - * Creates a JSON parser from the specified JSON object. - * - * @param obj a JSON object - * @return the created JSON parser - */ - JsonParser createParser(JsonObject obj); - - /** - * Creates a JSON parser from the specified JSON array. - * - * @param array a JSON array - * @return the created JSON parser - */ - JsonParser createParser(JsonArray array); - - /** - * Returns a read-only map of supported provider specific configuration - * properties that are used to configure the JSON parsers. - * If there are any specified configuration properties that are not - * supported by the provider, they won't be part of the returned map. - * - * @return a map of supported provider specific properties that are used - * to configure the created parsers. The map may be empty but not null - */ - Map getConfigInUse(); - -} Index: trunk/src/javax/json/stream/JsonParsingException.java =================================================================== --- trunk/src/javax/json/stream/JsonParsingException.java (revision 14273) +++ (revision ) @@ -1,96 +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. - */ - -package javax.json.stream; - -import javax.json.JsonException; - -/** - * {@code JsonParsingException} is used when an incorrect JSON is - * being parsed. - */ -public class JsonParsingException extends JsonException { - - private final JsonLocation location; - - /** - * Constructs a new runtime exception with the specified detail message. - * The cause is not initialized, and may subsequently be initialized by a - * call to {@link #initCause}. - * - * @param message the detail message. The detail message is saved for - * later retrieval by the {@link #getMessage()} method. - * @param location the location of the incorrect JSON - */ - public JsonParsingException(String message, JsonLocation location) { - super(message); - this.location = location; - } - - /** - * Constructs a new runtime exception with the specified detail message and - * cause.

Note that the detail message associated with - * {@code cause} is not automatically incorporated in - * this runtime exception's detail message. - * - * @param message the detail message (which is saved for later retrieval - * by the {@link #getMessage()} method). - * @param cause the cause (which is saved for later retrieval by the - * {@link #getCause()} method). (A null value is - * permitted, and indicates that the cause is nonexistent or - * unknown.) - * @param location the location of the incorrect JSON - */ - public JsonParsingException(String message, Throwable cause, JsonLocation location) { - super(message, cause); - this.location = location; - } - - /** - * Return the location of the incorrect JSON. - * - * @return the non-null location of the incorrect JSON - */ - public JsonLocation getLocation() { - return location; - } - -} - Index: trunk/src/javax/json/stream/package-info.java =================================================================== --- trunk/src/javax/json/stream/package-info.java (revision 14273) +++ (revision ) @@ -1,71 +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. - */ - -/** - * Provides a streaming API to parse and generate - * JSON. - * - *

- * The streaming API consists of the interfaces - * {@link javax.json.stream.JsonParser} and - * {@link javax.json.stream.JsonGenerator}. The interface {@code JsonParser} - * contains methods to parse JSON in a streaming way. The interface - * {@code JsonGenerator} contains methods to write JSON to an output source - * in a streaming way. - * - *

- * {@code JsonParser} provides forward, read-only access to JSON data using the - * pull parsing programming model. In this model the application code controls - * the thread and calls methods in the parser interface to move the parser - * forward or to obtain JSON data from the current state of the parser. - * - *

- * {@code JsonGenerator} provides methods to write JSON to an output source. - * The generator writes name/value pairs in JSON objects and values in JSON - * arrays. - * - *

- * The streaming API is a low-level API designed to process large amounts of - * JSON data efficiently. Other JSON frameworks (such as JSON binding) can be - * implemented using this API. - * - * @since JSON Processing 1.0 - */ -package javax.json.stream;