net.obvj.jsonmerge.provider

Interface JsonProvider<T>

Type Parameters:

T - the type that represents an actual JSON object at the JsonProvider

All Known Implementing Classes:

AbstractJsonProvider, GsonJsonProvider, JacksonJsonNodeJsonProvider, JsonOrgJsonProvider, JsonSmartJsonProvider, VertxJsonProvider

public interface JsonProvider<T>

An abstraction that represents a JSON provider (for example: Jackson, Gson, etc.) defining common operations for all implementations.

Since:

1.0.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

Method Summary

Modifier and Type	Method and Description
void	add(Object jsonArray, Object element) Appends the specified element to the end of the specified JSON array.
boolean	arrayContains(Object jsonArray, Object element) Checks if the specified JSON array contains the specified element.
Set<Map.Entry<String,Object>>	entrySet(Object jsonObject) Returns a Set view of the mappings contained in the specified JSON object.
void	forEachElementInArray(Object jsonArray, Consumer<? super Object> action) Performs the given action for each element of the specified JSON array until all entries have been processed.
Object	get(Object jsonArray, int index) Returns the element at the specified position in the specified JSON array.
Object	get(Object jsonObject, String key) Returns the value to which the specified key is mapped in the specified JSON object; or null if the JSON does not contain the specified key.
int	indexOf(Object jsonArray, Object element) Returns the index of the first occurrence of the specified element in the specified JSON array, or -1 if there is no such index.
boolean	isEmpty(Object jsonObject) Checks if the specified JSON object contains no data.
boolean	isJsonArray(Object object) Checks if the specified object is a JSON array for this provider.
boolean	isJsonObject(Object object) Checks if the specified object is a JSON object for this provider.
Object	newJsonArray() Creates a provider-specific JSON array.
Object	newJsonArray(Object sourceJsonArray) Creates a new provider-specific JSON array with the elements of a preset JSON array.
T	newJsonObject() Creates a provider-specific JSON object.
T	newJsonObject(Object sourceJsonObject) Creates a new provider-specific JSON object with the contents of a preset JSON object.
T	parse(InputStream inputStream) Deserializes a JSON from a specified InputStream.
T	parse(String string) Deserializes a JSON string into a JSON object.
void	put(Object jsonObject, String key, Object value) Associates the specified value with the specified key in the specified JSON object.
void	putIfAbsent(Object jsonObject, String key, Object value) Associates the specified value with the specified key in the specified JSON object, provided that the specified key is not already associated with a value in the JSON.
void	set(Object jsonArray, int index, Object element) Replaces the element at the specified position in the JSON array with the specified element.
int	size(Object jsonArray) Returns the number of elements in the specified JSON array.
Stream<Object>	stream(Object jsonArray) Returns a sequential Stream with the specified JSON array as its source.

Method Detail

parse

T parse(String string)

Deserializes a JSON string into a JSON object.

Parameters:

string - the source string

Returns:

a JSON object of the type defined by this provider

Throws:

NullPointerException - if the specified string is null

JsonParseException - if the specified string is an invalid JSON

Since:

1.1.0

parse

T parse(InputStream inputStream)

Deserializes a JSON from a specified InputStream.

Parameters:

inputStream - the source input stream

Returns:

a JSON object of the type defined by this provider

Throws:

JsonParseException - in case of invalid JSON or any other exception raised by the actual provider during parsing of the input stream

Since:

1.1.0

isJsonObject

boolean isJsonObject(Object object)

Checks if the specified object is a JSON object for this provider.

Parameters:

object - the object to be checked

Returns:

true if the specified object is a provider-specific JSON object; otherwise, false.

isJsonArray

boolean isJsonArray(Object object)

Checks if the specified object is a JSON array for this provider.

Parameters:

object - the object to be checked

Returns:

true if the specified object is a provider-specific JSON array; otherwise, false.

isEmpty

boolean isEmpty(Object jsonObject)

Checks if the specified JSON object contains no data.

Parameters:

jsonObject - the JSON object to be checked; not null

Returns:

true if the specified JSON object contains no data; otherwise, false.

Throws:

ClassCastException - if the specified parameter is not a valid JSON object for this provider

newJsonObject

T newJsonObject()

Creates a provider-specific JSON object.

Returns:

a new, empty JSON object

newJsonObject

T newJsonObject(Object sourceJsonObject)

Creates a new provider-specific JSON object with the contents of a preset JSON object.

Note: The resulting object is supposed to be shallow copy of the source JSON object.

Parameters:

sourceJsonObject - the JSON whose contents are to be copied; not null

Returns:

a new JSON object with the contents of the source JSON object

newJsonArray

Object newJsonArray()

Creates a provider-specific JSON array.

Returns:

a new, empty JSON array

newJsonArray

Object newJsonArray(Object sourceJsonArray)

Creates a new provider-specific JSON array with the elements of a preset JSON array.

Note: Although the actual implementation may vary depending on the concrete provider, the resulting object is supposed to be shallow copy of the source JSON array.

Parameters:

sourceJsonArray - the JSON array whose contents are to be copied; not null

Returns:

a new JSON array with the element of the source JSON array

entrySet

Set<Map.Entry<String,Object>> entrySet(Object jsonObject)

Returns a Set view of the mappings contained in the specified JSON object.

Parameters:

jsonObject - the JSON object whose entries shall be accessed; not null

Returns:

the entries of the specified JSON object.

Throws:

ClassCastException - if the specified parameter is not a valid JSON object for this provider

get

Object get(Object jsonObject,
           String key)

Returns the value to which the specified key is mapped in the specified JSON object; or null if the JSON does not contain the specified key.

Parameters:

jsonObject - the JSON object; not null

key - the key to be searched; not null

Returns:

the value associated with the specified key in the specified JSON

Throws:

ClassCastException - if the specified jsonObject is not a valid JSON object for this provider

get

Object get(Object jsonArray,
           int index)

Returns the element at the specified position in the specified JSON array.

Parameters:

jsonArray - the JSON array; not null

index - index of the element to return

Returns:

the element at the specified position in the specified JSON array

Throws:

ClassCastException - if the specified jsonObject is not a valid JSON object for this provider

IndexOutOfBoundsException - if the index is out of range (either negative or greater then the size of the array)

Since:

1.1.0

put

void put(Object jsonObject,
         String key,
         Object value)

Associates the specified value with the specified key in the specified JSON object.

Parameters:

jsonObject - the JSON object; not null

key - the key with which the specified value is to be associated in the JSON; not null

value - the value to be associated with the specified key in the JSON

Throws:

ClassCastException - if the specified jsonObject is not a valid JSON object for this provider

putIfAbsent

void putIfAbsent(Object jsonObject,
                 String key,
                 Object value)

Associates the specified value with the specified key in the specified JSON object, provided that the specified key is not already associated with a value in the JSON.

Parameters:

jsonObject - the JSON object; not null

key - the key with which the specified value is to be associated in the JSON; not null

value - the value to be associated with the specified key in the JSON, provided that the specified key is absent in the document

Throws:

ClassCastException - if the specified jsonObject is not a valid JSON object for this provider

add

void add(Object jsonArray,
         Object element)

Appends the specified element to the end of the specified JSON array.

Parameters:

jsonArray - the JSON array; not null

element - the element to be added

Throws:

ClassCastException - if the specified jsonArray is not a valid JSON array for this provider

set

void set(Object jsonArray,
         int index,
         Object element)

Replaces the element at the specified position in the JSON array with the specified element.

Parameters:

jsonArray - the JSON array; not null

index - the index of the element to replace

element - the element to be stored at the specified position

Throws:

ClassCastException - if the specified jsonArray is not a valid JSON array for this provider

IndexOutOfBoundsException - if the index is out of range (either negative or greater then the size of the array)

Since:

1.1.0

indexOf

int indexOf(Object jsonArray,
            Object element)

Returns the index of the first occurrence of the specified element in the specified JSON array, or -1 if there is no such index.

Parameters:

jsonArray - the JSON array; not null

element - the element to search for

Returns:

the index of the first occurrence of the specified element in the array, or -1 if the array does not contain the element

Throws:

ClassCastException - if the specified jsonArray is not a valid JSON array for this provider

Since:

1.1.0

forEachElementInArray

void forEachElementInArray(Object jsonArray,
                           Consumer<? super Object> action)

Performs the given action for each element of the specified JSON array until all entries have been processed.

Parameters:

jsonArray - the JSON array; not null

action - the action to be performed for each element; not null

Throws:

ClassCastException - if the specified jsonArray is not a valid JSON array for this provider

NullPointerException - if the specified action is null

arrayContains

boolean arrayContains(Object jsonArray,
                      Object element)

Checks if the specified JSON array contains the specified element.

Parameters:

jsonArray - the JSON array; not null

element - the element to be searched

Returns:

true if the specified JSON array contains the specified element; otherwise, false.

Throws:

ClassCastException - if the specified jsonArray is not a valid JSON array for this provider

stream

Stream<Object> stream(Object jsonArray)

Returns a sequential Stream with the specified JSON array as its source.

Parameters:

jsonArray - the JSON array; not null

Returns:

a sequential Stream over the elements in this JSON array

Throws:

ClassCastException - if the specified jsonArray is not a valid JSON array for this provider

size

int size(Object jsonArray)

Returns the number of elements in the specified JSON array.

Parameters:

jsonArray - the JSON array; not null

Returns:

the number of elements in the specified JSON array

Since:

1.1.0