Package com.jayway.jsonpath.spi.json

Class JakartaJsonProvider

java.lang.Object

com.jayway.jsonpath.spi.json.AbstractJsonProvider

com.jayway.jsonpath.spi.json.JakartaJsonProvider

All Implemented Interfaces:

JsonProvider

public class JakartaJsonProvider
extends AbstractJsonProvider

Field Summary

Fields inherited from interface com.jayway.jsonpath.spi.json.JsonProvider

UNDEFINED

Constructor Summary

Constructors

Constructor	Description
JakartaJsonProvider()	Constructs new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider.
JakartaJsonProvider(boolean mutableJson)	Constructs new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider, and optionally enables proxying of JsonObject and JsonArray entities to implement mutable JSON structures.

Method Summary

Modifier and Type	Method	Description
Object	createArray()	Creates a provider specific json array
Object	createMap()	Creates a provider specific json object
Object	getArrayIndex(Object obj, int idx)	Extracts a value from an array
Object	getMapValue(Object obj, String key)	Extracts a value from an map
Collection<String>	getPropertyKeys(Object obj)	Returns the keys from the given object
boolean	isArray(Object obj)	checks if object is an array
boolean	isMap(Object obj)	checks if object is a map (i.e.
int	length(Object obj)	Get the length of an array or object
Object	parse(byte[] json)	Parse the given json bytes in UTF-8 encoding
Object	parse(InputStream jsonStream, String charset)	Parse the given json string
Object	parse(String json)	Parse the given json string
void	removeProperty(Object obj, Object key)	Removes a value in an object or array
void	setArrayIndex(Object array, int index, Object newValue)	Sets a value in an array.
void	setProperty(Object obj, Object key, Object value)	Sets a value in an object
Iterable<?>	toIterable(Object obj)	Converts given array to an Iterable
String	toJson(Object obj)	Convert given json object to a json string
Object	unwrap(Object obj)	Extracts a value from a wrapper object.

Methods inherited from class com.jayway.jsonpath.spi.json.AbstractJsonProvider

getArrayIndex

Methods inherited from class java.lang.Object

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

Constructor Details

JakartaJsonProvider

public JakartaJsonProvider()

Constructs new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider. JSON files, strings, and streams can be loaded, parsed, and navigated with JsonPath expressions, and values retrieved - but no changes to the loaded JSON document are permitted, and will yield exceptions.

JakartaJsonProvider

public JakartaJsonProvider(boolean mutableJson)

Constructs new instance of parsing and serialization adapter for Jakarta EE 9 JSON-P default provider, and optionally enables proxying of JsonObject and JsonArray entities to implement mutable JSON structures. By default, all structures and values produced and consumed by JSON-P are immutable. This comes at an extra cost to perfomance and memory consumption, so enable only if expected use cases include add/put/replace/delete operations on JSON document.

Parameters:

mutableJson - enable dynamic proxies for JSON structures

Method Details

parse

public Object parse(String json)
             throws InvalidJsonException

Description copied from interface: JsonProvider

Parse the given json string

Parameters:

json - json string to parse

Returns:

Object representation of json

Throws:

InvalidJsonException

parse

public Object parse(byte[] json)
             throws InvalidJsonException

Description copied from interface: JsonProvider

Parse the given json bytes in UTF-8 encoding

Parameters:

json - json bytes to parse

Returns:

Object representation of json

Throws:

InvalidJsonException

parse

public Object parse(InputStream jsonStream,
 String charset)
             throws InvalidJsonException

Description copied from interface: JsonProvider

Parse the given json string

Parameters:

jsonStream - input stream to parse

charset - charset to use

Returns:

Object representation of json

Throws:

InvalidJsonException

toJson

public String toJson(Object obj)

Description copied from interface: JsonProvider

Convert given json object to a json string

Parameters:

obj - object to transform

Returns:

json representation of object

createArray

public Object createArray()

Description copied from interface: JsonProvider

Creates a provider specific json array

Returns:

new array

createMap

public Object createMap()

Description copied from interface: JsonProvider

Creates a provider specific json object

Returns:

new object

isArray

public boolean isArray(Object obj)

Description copied from class: AbstractJsonProvider

checks if object is an array

Specified by:

isArray in interface JsonProvider

Overrides:

isArray in class AbstractJsonProvider

Parameters:

obj - object to check

Returns:

true if obj is an array

getArrayIndex

public Object getArrayIndex(Object obj,
 int idx)

Description copied from class: AbstractJsonProvider

Extracts a value from an array

Specified by:

getArrayIndex in interface JsonProvider

Overrides:

getArrayIndex in class AbstractJsonProvider

Parameters:

obj - an array

idx - index

Returns:

the entry at the given index

setArrayIndex

public void setArrayIndex(Object array,
 int index,
 Object newValue)

Description copied from interface: JsonProvider

Sets a value in an array. If the array is too small, the provider is supposed to enlarge it.

Specified by:

setArrayIndex in interface JsonProvider

Overrides:

setArrayIndex in class AbstractJsonProvider

Parameters:

array - an array

index - index

newValue - the new value

getMapValue

public Object getMapValue(Object obj,
 String key)

Description copied from class: AbstractJsonProvider

Extracts a value from an map

Specified by:

getMapValue in interface JsonProvider

Overrides:

getMapValue in class AbstractJsonProvider

Parameters:

obj - a map

key - property key

Returns:

the map entry or JsonProvider.UNDEFINED for missing properties

setProperty

public void setProperty(Object obj,
 Object key,
 Object value)

Description copied from class: AbstractJsonProvider

Sets a value in an object

Specified by:

setProperty in interface JsonProvider

Overrides:

setProperty in class AbstractJsonProvider

Parameters:

obj - an object

key - a String key

value - the value to set

removeProperty

public void removeProperty(Object obj,
 Object key)

Description copied from class: AbstractJsonProvider

Removes a value in an object or array

Specified by:

removeProperty in interface JsonProvider

Overrides:

removeProperty in class AbstractJsonProvider

Parameters:

obj - an array or an object

key - a String key or a numerical index to remove

isMap

public boolean isMap(Object obj)

Description copied from class: AbstractJsonProvider

checks if object is a map (i.e. no array)

Specified by:

isMap in interface JsonProvider

Overrides:

isMap in class AbstractJsonProvider

Parameters:

obj - object to check

Returns:

true if the object is a map

getPropertyKeys

public Collection<String> getPropertyKeys(Object obj)

Description copied from class: AbstractJsonProvider

Returns the keys from the given object

Specified by:

getPropertyKeys in interface JsonProvider

Overrides:

getPropertyKeys in class AbstractJsonProvider

Parameters:

obj - an object

Returns:

the keys for an object

length

public int length(Object obj)

Description copied from class: AbstractJsonProvider

Get the length of an array or object

Specified by:

length in interface JsonProvider

Overrides:

length in class AbstractJsonProvider

Parameters:

obj - an array or an object

Returns:

the number of entries in the array or object

toIterable

public Iterable<?> toIterable(Object obj)

Description copied from class: AbstractJsonProvider

Converts given array to an Iterable

Specified by:

toIterable in interface JsonProvider

Overrides:

toIterable in class AbstractJsonProvider

Parameters:

obj - an array

Returns:

an Iterable that iterates over the entries of an array

unwrap

public Object unwrap(Object obj)

Description copied from interface: JsonProvider

Extracts a value from a wrapper object. For JSON providers that to not wrap values, this will usually be the object itself.

Specified by:

unwrap in interface JsonProvider

Overrides:

unwrap in class AbstractJsonProvider

Parameters:

obj - a value holder object

Returns:

the unwrapped value.