net.obvj.jsonmerge

Class JsonMergeOption.Builder

java.lang.Object

net.obvj.jsonmerge.JsonMergeOption.Builder

Enclosing class:

JsonMergeOption

public static class JsonMergeOption.Builder
extends Object

A builder for JsonMergeOption, with the document path already set.

Since:

1.1.0

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
JsonMergeOption	addAll() Add all elements of the both JSON documents during the merge of the specified array path, with no duplication check.
JsonMergeOption	addDistinctObjectsOnly() Avoid duplicate objects during the merge of the specified array path (default option).
JsonMergeOption.BuilderWithKeys	findObjectsIdentifiedBy(String... keys) Defines one or more keys to determine object equality inside the specified document path, provided that the path is an array path.

Methods inherited from class java.lang.Object

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

Method Detail

findObjectsIdentifiedBy

public JsonMergeOption.BuilderWithKeys findObjectsIdentifiedBy(String... keys)

Defines one or more keys to determine object equality inside the specified document path, provided that the path is an array path.

For example, consider the following JSON document:

 {
   "params": [
     {
       "name": "country",
       "value": "Brazil"
     },
     {
       "name": "language",
       "value": "pt-BR"
     }
   ]
 }
 

A JsonMergeOption associating the "name" key with the "$.params" path tells the algorithm to find distinct objects identified by the "name" key during the merge of the "$.params" array.

In other words, if two JSON documents contain different objects with same value for the provided key(s), then they will be considered as "equal" during the merge.

Parameters:

keys - one or more keys to determine object equality inside an array path

Returns:

an intermediary JsonMergeOption build stage with the specified key(s)

Throws:

IllegalArgumentException - if a null or blank key is received

addDistinctObjectsOnly

public JsonMergeOption addDistinctObjectsOnly()

Avoid duplicate objects during the merge of the specified array path (default option).

Returns:

a finalized JsonMergeOption

addAll

public JsonMergeOption addAll()

Add all elements of the both JSON documents during the merge of the specified array path, with no duplication check.

Returns:

a finalized JsonMergeOption