com.jayway.jsonpath.spi

Interface JsonProvider

All Known Implementing Classes:

AbstractJsonProvider, JacksonProvider, JsonSmartJsonProvider

public interface JsonProvider

Author:

Kalle Stenflo

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone(Object model)
Iterable	createArray()
Object	createMap()
Mode	getMode()
Object	getProperty(Object obj, Object key) Extracts a value from an object or array
Collection<String>	getPropertyKeys(Object obj) Returns the keys from the given object or the indexes from an array
boolean	isArray(Object obj) checks if object is an array
boolean	isContainer(Object obj) checks if object is a map or 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(InputStream jsonStream)
Object	parse(Reader jsonReader)
Object	parse(String json)
void	setProperty(Object obj, Object key, Object value) Sets a value in an object or array
Iterable<Object>	toIterable(Object obj) Converts given object to an Iterable
String	toJson(Object obj)

Method Detail

getMode

Mode getMode()

parse

Object parse(String json)
             throws InvalidJsonException

Throws:

InvalidJsonException

parse

Object parse(Reader jsonReader)
             throws InvalidJsonException

Throws:

InvalidJsonException

parse

Object parse(InputStream jsonStream)
             throws InvalidJsonException

Throws:

InvalidJsonException

toJson

String toJson(Object obj)

createMap

Object createMap()

createArray

Iterable createArray()

clone

Object clone(Object model)

isContainer

boolean isContainer(Object obj)

checks if object is a map or an array

Parameters:

obj - object to check

Returns:

true if obj is a map or an array

isArray

boolean isArray(Object obj)

checks if object is an array

Parameters:

obj - object to check

Returns:

true if obj is an array

length

int length(Object obj)

Get the length of an array or object

Parameters:

obj - an array or an object

Returns:

the number of entries in the array or object

toIterable

Iterable<Object> toIterable(Object obj)

Converts given object to an Iterable

Parameters:

obj - an array or an object

Returns:

the entries for an array or the values for a map

getPropertyKeys

Collection<String> getPropertyKeys(Object obj)

Returns the keys from the given object or the indexes from an array

Parameters:

obj - an array or an object

Returns:

the keys for an object or the indexes for an array

getProperty

Object getProperty(Object obj,
                 Object key)

Extracts a value from an object or array

Parameters:

obj - an array or an object

key - a String key or a numerical index

Returns:

the entry at the given key, i.e. obj[key]

setProperty

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

Sets a value in an object or array

Parameters:

obj - an array or an object

key - a String key or a numerical index

value - the value to set

isMap

boolean isMap(Object obj)

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

Parameters:

obj - object to check

Returns:

true if the object is a map