net.obvj.jsonmerge.provider

Class GsonJsonProvider

java.lang.Object

net.obvj.jsonmerge.provider.AbstractJsonProvider<com.google.gson.JsonObject>

net.obvj.jsonmerge.provider.GsonJsonProvider

All Implemented Interfaces:

JsonProvider<com.google.gson.JsonObject>

public class GsonJsonProvider
extends AbstractJsonProvider<com.google.gson.JsonObject>

A specialized JsonProvider implementation for Gson.

Since:

1.0.0

Author:

oswaldo.bapvic.jr (Oswaldo Junior)

See Also:

Gson Project home, JsonObject, JsonArray

Constructor Summary

Constructors

Constructor and Description
GsonJsonProvider()

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.
com.google.gson.JsonObject	newJsonObject() Creates a provider-specific JSON object.
com.google.gson.JsonObject	newJsonObject(Object sourceJsonObject) Creates a new provider-specific JSON object with the contents of a preset 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.

Methods inherited from class net.obvj.jsonmerge.provider.AbstractJsonProvider

equals, parse, parse

Methods inherited from class java.lang.Object

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

Constructor Detail

GsonJsonProvider

public GsonJsonProvider()

Method Detail

isJsonObject

public boolean isJsonObject(Object object)

Description copied from interface: JsonProvider

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

public boolean isJsonArray(Object object)

Description copied from interface: JsonProvider

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

public boolean isEmpty(Object jsonObject)

Description copied from interface: JsonProvider

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.

newJsonObject

public com.google.gson.JsonObject newJsonObject()

Description copied from interface: JsonProvider

Creates a provider-specific JSON object.

Returns:

a new, empty JSON object

newJsonObject

public com.google.gson.JsonObject newJsonObject(Object sourceJsonObject)

Description copied from interface: JsonProvider

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

public Object newJsonArray()

Description copied from interface: JsonProvider

Creates a provider-specific JSON array.

Returns:

a new, empty JSON array

newJsonArray

public Object newJsonArray(Object sourceJsonArray)

Description copied from interface: JsonProvider

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

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

Description copied from interface: JsonProvider

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.

get

public Object get(Object jsonObject,
                  String key)

Description copied from interface: JsonProvider

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

get

public Object get(Object jsonArray,
                  int index)

Description copied from interface: JsonProvider

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

put

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

Description copied from interface: JsonProvider

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

putIfAbsent

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

Description copied from interface: JsonProvider

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

add

public void add(Object jsonArray,
                Object element)

Description copied from interface: JsonProvider

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

set

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

Description copied from interface: JsonProvider

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

indexOf

public int indexOf(Object jsonArray,
                   Object element)

Description copied from interface: JsonProvider

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

forEachElementInArray

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

Description copied from interface: JsonProvider

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

arrayContains

public boolean arrayContains(Object jsonArray,
                             Object element)

Description copied from interface: JsonProvider

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.

stream

public Stream<Object> stream(Object jsonArray)

Description copied from interface: JsonProvider

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

size

public int size(Object jsonArray)

Description copied from interface: JsonProvider

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