Package javax.json

Class Json

java.lang.Object

javax.json.Json

public final class Json
extends Object

Method Summary

Modifier and Type	Method	Description
static JsonArrayBuilder	createArrayBuilder()
static JsonArrayBuilder	createArrayBuilder(Collection<?> initialData)	Creates a JSON array builder, initialized with an initial content
static JsonArrayBuilder	createArrayBuilder(JsonArray initialData)	Creates a JSON array builder, initialized with an initial content taken from a JsonArray
static JsonBuilderFactory	createBuilderFactory(Map<String,?> config)
static JsonPatch	createDiff(JsonStructure source, JsonStructure target)	Create a JsonPatch by comparing the source to the target as defined in RFC-6902.
static JsonGenerator	createGenerator(OutputStream out)
static JsonGenerator	createGenerator(Writer writer)
static JsonGeneratorFactory	createGeneratorFactory(Map<String,?> config)
static JsonMergePatch	createMergeDiff(JsonValue source, JsonValue target)	Create a JSON Merge Patch (RFC 7396) from the source and target JsonValues.
static JsonMergePatch	createMergePatch(JsonValue patch)	Creates JSON Merge Patch (RFC 7396) from a specified JsonValue.
static JsonObjectBuilder	createObjectBuilder()	Create an empty JsonObjectBuilder
static JsonObjectBuilder	createObjectBuilder(Map<String,Object> map)	Creates a JSON object builder, initialized with the specified Map.
static JsonObjectBuilder	createObjectBuilder(JsonObject object)	Creates a JSON object builder, initialized with the specified JsonObject.
static JsonParser	createParser(InputStream in)
static JsonParser	createParser(Reader reader)
static JsonParserFactory	createParserFactory(Map<String,?> config)
static JsonPatch	createPatch(JsonArray array)	Create a JsonPatch as defined in RFC-6902.
static JsonPatchBuilder	createPatchBuilder()	Create a new JsonPatchBuilder
static JsonPatchBuilder	createPatchBuilder(JsonArray initialData)	Create a new JsonPatchBuilder
static JsonPointer	createPointer(String path)	Create a JsonPointer for the given path
static JsonReader	createReader(InputStream in)
static JsonReader	createReader(Reader reader)
static JsonReaderFactory	createReaderFactory(Map<String,?> config)
static JsonNumber	createValue(double value)
static JsonNumber	createValue(int value)
static JsonNumber	createValue(long value)
static JsonString	createValue(String value)
static JsonNumber	createValue(BigDecimal value)
static JsonNumber	createValue(BigInteger value)
static JsonWriter	createWriter(OutputStream out)
static JsonWriter	createWriter(Writer writer)
static JsonWriterFactory	createWriterFactory(Map<String,?> config)
static String	decodePointer(String escapedPointer)
static String	encodePointer(String pointer)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createParser

public static JsonParser createParser(Reader reader)

createParser

public static JsonParser createParser(InputStream in)

createGenerator

public static JsonGenerator createGenerator(Writer writer)

createGenerator

public static JsonGenerator createGenerator(OutputStream out)

createParserFactory

public static JsonParserFactory createParserFactory(Map<String,?> config)

createGeneratorFactory

public static JsonGeneratorFactory createGeneratorFactory(Map<String,?> config)

createWriter

public static JsonWriter createWriter(Writer writer)

createWriter

public static JsonWriter createWriter(OutputStream out)

createReader

public static JsonReader createReader(Reader reader)

createReader

public static JsonReader createReader(InputStream in)

createReaderFactory

public static JsonReaderFactory createReaderFactory(Map<String,?> config)

createWriterFactory

public static JsonWriterFactory createWriterFactory(Map<String,?> config)

createArrayBuilder

public static JsonArrayBuilder createArrayBuilder()

createObjectBuilder

public static JsonObjectBuilder createObjectBuilder()

Create an empty JsonObjectBuilder

Since:

1.0

createObjectBuilder

public static JsonObjectBuilder createObjectBuilder(JsonObject object)

Creates a JSON object builder, initialized with the specified JsonObject.

Since:

1.1

createObjectBuilder

public static JsonObjectBuilder createObjectBuilder(Map<String,Object> map)

Creates a JSON object builder, initialized with the specified Map.

Since:

1.1

createBuilderFactory

public static JsonBuilderFactory createBuilderFactory(Map<String,?> config)

createArrayBuilder

public static JsonArrayBuilder createArrayBuilder(JsonArray initialData)

Creates a JSON array builder, initialized with an initial content taken from a JsonArray

Parameters:

initialData - the initial array in the builder

Returns:

a JSON array builder

Since:

1.1

createArrayBuilder

public static JsonArrayBuilder createArrayBuilder(Collection<?> initialData)

Creates a JSON array builder, initialized with an initial content

Parameters:

initialData - the initial array in the builder

Returns:

a JSON array builder

Since:

1.1

createValue

public static JsonString createValue(String value)

createValue

public static JsonNumber createValue(int value)

createValue

public static JsonNumber createValue(long value)

createValue

public static JsonNumber createValue(double value)

createValue

public static JsonNumber createValue(BigDecimal value)

createValue

public static JsonNumber createValue(BigInteger value)

createPatch

public static JsonPatch createPatch(JsonArray array)

Create a JsonPatch as defined in RFC-6902.

Parameters:

array - with the patch operations

Returns:

the JsonPatch based on the given operations

Since:

1.1

createDiff

public static JsonPatch createDiff(JsonStructure source,
                                   JsonStructure target)

Create a JsonPatch by comparing the source to the target as defined in RFC-6902.

Applying this JsonPatch to the source you will give you the target.

Since:

1.1

See Also:

createPatch(JsonArray)

createPatchBuilder

public static JsonPatchBuilder createPatchBuilder()

Create a new JsonPatchBuilder

Since:

1.1

createPatchBuilder

public static JsonPatchBuilder createPatchBuilder(JsonArray initialData)

Create a new JsonPatchBuilder

Parameters:

initialData - the initial patch operations

Since:

1.1

createMergePatch

public static JsonMergePatch createMergePatch(JsonValue patch)

Creates JSON Merge Patch (RFC 7396) from a specified JsonValue. Create a merged patch by comparing the source to the target.

Applying this JsonPatch to the source will give you the target.

If you have a JSON like

 {
   "a": "b",
   "c": {
     "d": "e",
     "f": "g"
   }
 }
 

Then you can change the value of "a" and removing "f" by sending:

 {
   "a":"z",
   "c": {
     "f": null
   }
 }
 

Parameters:

patch - the patch

Returns:

a JSON Merge Patch

Since:

1.1

createMergeDiff

public static JsonMergePatch createMergeDiff(JsonValue source,
                                             JsonValue target)

Create a JSON Merge Patch (RFC 7396) from the source and target JsonValues. Create a merged patch by comparing the source to the target.

Applying this JsonPatch to the source will give you the target.

If you have a JSON like

 {
   "a": "b",
   "c": {
     "d": "e",
     "f": "g"
   }
 }
 

Then you can change the value of "a" and removing "f" by sending:

 {
   "a":"z",
   "c": {
     "f": null
   }
 }
 

Parameters:

source - the source

target - the target

Returns:

a JSON Merge Patch

Since:

1.1

createPointer

public static JsonPointer createPointer(String path)

Create a JsonPointer for the given path

Since:

1.1

encodePointer

public static String encodePointer(String pointer)

Parameters:

pointer - to encode

Returns:

the properly encoded JsonPointer string

Since:

1.1

decodePointer

public static String decodePointer(String escapedPointer)

Parameters:

escapedPointer -

Returns:

the de-escaped JsonPointer

Since:

1.1