com.zackehh.jackson

Class Jive

java.lang.Object

com.zackehh.jackson.Jive

public class Jive
extends Object

The Jive class provides various utilities for working with Jackson JSON modules, specifically ArrayNode and ObjectNode values. The intent is to remove friction from user interaction with Jackson bindings by providing just enough to make implementing new behaviour easy. One example is the $stream(ArrayNode) function which allows a user to begin working with the Stream interface against their JSON values.

Method Summary

Modifier and Type	Method and Description
static com.fasterxml.jackson.databind.node.ArrayNode	concat(com.fasterxml.jackson.databind.node.ArrayNode... nodes) Concatenates multiple ArrayNode instances.
static boolean	contains(com.fasterxml.jackson.databind.node.ArrayNode node, com.fasterxml.jackson.databind.JsonNode value) Determines whether a JsonNode exists in an ArrayNode.
static boolean	contains(com.fasterxml.jackson.databind.node.ObjectNode node, com.fasterxml.jackson.databind.JsonNode value) Determines whether a JsonNode exists in an ObjectNode as a value entry.
static com.fasterxml.jackson.databind.node.ArrayNode	drop(com.fasterxml.jackson.databind.node.ArrayNode node, int count) Returns a new ArrayNode with the first N items removed.
static boolean	every(com.fasterxml.jackson.databind.node.ArrayNode node, Predicate<com.fasterxml.jackson.databind.JsonNode> predicate) Determines whether all JsonNodes within an ArrayNode fit a provided Predicate condition.
static boolean	every(com.fasterxml.jackson.databind.node.ObjectNode node, Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate) Determines whether all entries within an ObjectNode fit a provided Predicate condition.
static <T> Optional<T>	execute(Callable<T> execution) Executes a scoped function with caught Exceptions.
static <T> Optional<T>	execute(com.fasterxml.jackson.databind.ObjectMapper mapper, SafeExecution<T> execution) Executes a scoped function with the provided ObjectMapper.
static com.fasterxml.jackson.databind.node.ArrayNode	filter(com.fasterxml.jackson.databind.node.ArrayNode node, Predicate<com.fasterxml.jackson.databind.JsonNode> predicate) Filters values in an ArrayNode into a new ArrayNode.
static com.fasterxml.jackson.databind.node.ObjectNode	filter(com.fasterxml.jackson.databind.node.ObjectNode node, Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate) Filters values in an ObjectNode into a new ObjectNode.
static Optional<com.fasterxml.jackson.databind.JsonNode>	find(com.fasterxml.jackson.databind.node.ArrayNode node, Predicate<com.fasterxml.jackson.databind.JsonNode> predicate) Attempts to find an ArrayNode value matching a criteria.
static Optional<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>>	find(com.fasterxml.jackson.databind.node.ObjectNode node, Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate) Attempts to find an ObjectNode entry matching a criteria.
static Set<String>	keys(com.fasterxml.jackson.databind.node.ObjectNode node) Returns an Set of Strings instance containing all keys of the provided ObjectNode.
static com.fasterxml.jackson.databind.JsonNode	last(com.fasterxml.jackson.databind.node.ArrayNode node) Retrieves the last value in an ArrayNode.
static com.fasterxml.jackson.databind.node.ArrayNode	map(com.fasterxml.jackson.databind.node.ArrayNode node, Function<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode> function) Maps values in an ArrayNode into a new ArrayNode.
static com.fasterxml.jackson.databind.node.ObjectNode	map(com.fasterxml.jackson.databind.node.ObjectNode node, Function<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>,Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> function) Maps entries in an ObjectNode into a new ObjectNode.
static com.fasterxml.jackson.databind.node.ObjectNode	merge(com.fasterxml.jackson.databind.node.ObjectNode... nodes) Performs a shallow merge of multiple ObjectNodes.
static com.fasterxml.jackson.databind.node.ArrayNode	newArrayNode() Constructs a new Jackson ArrayNode instance.
static com.fasterxml.jackson.databind.node.ArrayNode	newArrayNode(com.fasterxml.jackson.databind.JsonNode... nodes) Constructs a new Jackson ArrayNode instance.
static com.fasterxml.jackson.databind.node.BigIntegerNode	newBigIntegerNode(BigInteger value) Constructs a new BigIntegerNode from a BigDecimal value.
static com.fasterxml.jackson.databind.node.BinaryNode	newBinaryNode(byte[] value) Constructs a new BinaryNode from a byte[] value.
static com.fasterxml.jackson.databind.node.BooleanNode	newBooleanNode(Boolean value) Constructs a new BooleanNode from a Boolean value.
static com.fasterxml.jackson.databind.node.DecimalNode	newDecimalNode(BigDecimal value) Constructs a new DecimalNode from a BigDecimal value.
static com.fasterxml.jackson.databind.node.DoubleNode	newDoubleNode(Double value) Constructs a new DoubleNode from a Double value.
static com.fasterxml.jackson.databind.node.FloatNode	newFloatNode(Float value) Constructs a new FloatNode from a Float value.
static com.fasterxml.jackson.databind.node.IntNode	newIntNode(Integer value) Constructs a new IntNode from an Integer value.
static Iterable<com.fasterxml.jackson.databind.JsonNode>	newIterable(com.fasterxml.jackson.databind.JsonNode node) Constructs a new Iterable of type JsonNode using the provided input.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, BigDecimal value) Constructs a new JSON Map.Entry from a BigDecimal value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, BigInteger value) Constructs a new JSON Map.Entry from a BigInteger value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, Boolean value) Constructs a new JSON Map.Entry from a Boolean value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, byte[] value) Constructs a new JSON Map.Entry from a byte[] value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, Double value) Constructs a new JSON Map.Entry from a Double value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, Float value) Constructs a new JSON Map.Entry from a Float value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, Integer value) Constructs a new JSON Map.Entry from an Integer value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, com.fasterxml.jackson.databind.JsonNode value) Constructs a new JSON Map.Entry from a JsonNode value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, Long value) Constructs a new JSON Map.Entry from a Long value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, Object value) Constructs a new JSON Map.Entry from an Object value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, Short value) Constructs a new JSON Map.Entry from a Short value.
static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>	newJsonEntry(String key, String value) Constructs a new JSON Map.Entry from a String value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(BigDecimal value) Constructs a new JsonNode from a BigDecimal value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(BigInteger value) Constructs a new JsonNode from a BigInteger value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(Boolean value) Constructs a new JsonNode from a Boolean value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(byte[] value) Constructs a new JsonNode from a byte[] value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(Double value) Constructs a new JsonNode from a Double value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(Float value) Constructs a new JsonNode from a Float value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(Integer value) Constructs a new JsonNode from an Integer value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(Long value) Constructs a new JsonNode from a Long value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(Object value) Constructs a new JsonNode from an Object value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(Short value) Constructs a new JsonNode from a Short value.
static com.fasterxml.jackson.databind.JsonNode	newJsonNode(String value) Constructs a new JsonNode from a String value.
static com.fasterxml.jackson.databind.node.LongNode	newLongNode(Long value) Constructs a new LongNode from a Long value.
static com.fasterxml.jackson.databind.node.ObjectNode	newObjectNode() Constructs a new Jackson ObjectNode instance.
static com.fasterxml.jackson.databind.node.ObjectNode	newObjectNode(Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>... entries) Constructs a new Jackson ObjectNode instance.
static com.fasterxml.jackson.databind.node.POJONode	newPojoNode(Object value) Constructs a new POJONode from an Object value.
static com.fasterxml.jackson.databind.node.ShortNode	newShortNode(Short value) Constructs a new ShortNode from a Short value.
static com.fasterxml.jackson.databind.node.TextNode	newTextNode(String value) Constructs a new TextNode from a String value.
static boolean	none(com.fasterxml.jackson.databind.node.ArrayNode node, Predicate<com.fasterxml.jackson.databind.JsonNode> predicate) Returns true if no values in the ArrayNode match the provided predicate.
static boolean	none(com.fasterxml.jackson.databind.node.ObjectNode node, Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate) Returns true if no entries in the ObjectNode match the provided predicate.
static com.fasterxml.jackson.databind.node.ObjectNode	omit(com.fasterxml.jackson.databind.node.ObjectNode node, Collection<String> keys) Returns an ObjectNode instance without the provided list of keys using the provided ObjectNode instance.
static com.fasterxml.jackson.databind.node.ObjectNode	omit(com.fasterxml.jackson.databind.node.ObjectNode node, String... keys) Returns an ObjectNode instance without the provided list of keys using the provided ObjectNode instance.
static com.fasterxml.jackson.databind.node.ObjectNode	pick(com.fasterxml.jackson.databind.node.ObjectNode node, Collection<String> keys) Returns an ObjectNode instance created from the provided Set of keys using the provided ObjectNode instance.
static com.fasterxml.jackson.databind.node.ObjectNode	pick(com.fasterxml.jackson.databind.node.ObjectNode node, String... keys) Returns an ObjectNode instance created from the provided list of keys using the provided ObjectNode instance.
static <T> T	reduce(com.fasterxml.jackson.databind.node.ArrayNode node, T initial, BiFunction<T,com.fasterxml.jackson.databind.JsonNode,T> function) Reduces an ArrayNode into a single value of type T using the provided function to accumulate values.
static <T> T	reduce(com.fasterxml.jackson.databind.node.ObjectNode node, T initial, BiFunction<T,Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>,T> function) Reduces an ObjectNode into a single value of type T using the provided function to accumulate values.
static com.fasterxml.jackson.databind.node.ArrayNode	reject(com.fasterxml.jackson.databind.node.ArrayNode node, Predicate<com.fasterxml.jackson.databind.JsonNode> predicate) Filters values in an ArrayNode into a new ArrayNode.
static com.fasterxml.jackson.databind.node.ObjectNode	reject(com.fasterxml.jackson.databind.node.ObjectNode node, Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate) Filters values in an ObjectNode into a new ObjectNode.
static boolean	some(com.fasterxml.jackson.databind.node.ArrayNode node, Predicate<com.fasterxml.jackson.databind.JsonNode> predicate) Returns true if some values in the ArrayNode match the provided predicate.
static boolean	some(com.fasterxml.jackson.databind.node.ObjectNode node, Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate) Returns true if some entries in the ObjectNode match the provided predicate.
static Stream<com.fasterxml.jackson.databind.JsonNode>	stream(com.fasterxml.jackson.databind.node.ArrayNode node) Creates a new Stream from the provided ArrayNode.
static Stream<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>>	stream(com.fasterxml.jackson.databind.node.ObjectNode node) Creates a new Stream from the provided ObjectNode.
static com.fasterxml.jackson.databind.node.ArrayNode	take(com.fasterxml.jackson.databind.node.ArrayNode node, int count) Returns a new ArrayNode containing N taken items from a provided ArrayNode instance.
static com.fasterxml.jackson.databind.node.ArrayNode	transform(com.fasterxml.jackson.databind.node.ArrayNode node, Function<Stream<com.fasterxml.jackson.databind.JsonNode>,Stream<com.fasterxml.jackson.databind.JsonNode>> transformer) Transforms a provided ArrayNode into a new ArrayNode instance.
static com.fasterxml.jackson.databind.node.ObjectNode	transform(com.fasterxml.jackson.databind.node.ObjectNode node, Function<Stream<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>>,Stream<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>>> transformer) Transforms a provided ObjectNode into a new ObjectNode instance.
static com.fasterxml.jackson.databind.node.ArrayNode	uniq(com.fasterxml.jackson.databind.node.ArrayNode node) Returns an ArrayNode instance with all duplicate values removed.
static com.fasterxml.jackson.databind.node.ArrayNode	values(com.fasterxml.jackson.databind.node.ObjectNode node) Returns an ArrayNode instance containing all values of the provided ObjectNode.

Methods inherited from class java.lang.Object

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

Method Detail

concat

public static com.fasterxml.jackson.databind.node.ArrayNode concat(com.fasterxml.jackson.databind.node.ArrayNode... nodes)

Concatenates multiple ArrayNode instances. The returned value is a new ArrayNode instance, rather than modifying one of the input instances.

Parameters:

nodes - the ArrayNode instances to concatenate.

Returns:

a new ArrayNode instance of all provided nodes.

contains

public static boolean contains(com.fasterxml.jackson.databind.node.ArrayNode node,
                               com.fasterxml.jackson.databind.JsonNode value)

Determines whether a JsonNode exists in an ArrayNode.

Parameters:

node - the ArrayNode to search within.

value - the JsonNode value to search for.

Returns:

true if the JsonNode value can be found.

contains

public static boolean contains(com.fasterxml.jackson.databind.node.ObjectNode node,
                               com.fasterxml.jackson.databind.JsonNode value)

Determines whether a JsonNode exists in an ObjectNode as a value entry.

Parameters:

node - the ObjectNode to search within.

value - the JsonNode value to search for.

Returns:

true if the JsonNode value can be found.

drop

public static com.fasterxml.jackson.databind.node.ArrayNode drop(com.fasterxml.jackson.databind.node.ArrayNode node,
                                                                 int count)

Returns a new ArrayNode with the first N items removed. This does not modify the original ArrayNode input, but returns a new ArrayNode instance with the nodes added.

Parameters:

node - the node to drop from.

count - the number of nodes to drop.

Returns:

a new ArrayNode instance with dropped nodes.

execute

public static <T> Optional<T> execute(Callable<T> execution)

Executes a scoped function with caught Exceptions. Any thrown IOException instances will be caught and will return an empty Optional to the user. In the case of a successful execution, the return value of the called block will be wrapped into an Optional and returned. This function can be used to remove the need to manually handle exceptions when calling ObjectMapper functions.

Type Parameters:

T - the type of the block return value.

Parameters:

execution - the execution implementation to call.

Returns:

an Optional containing a potential result.

execute

public static <T> Optional<T> execute(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                      SafeExecution<T> execution)

Executes a scoped function with the provided ObjectMapper. Any thrown Exception instances will be caught and will return an empty Optional to the user. In the case of a successful execution, the return value of the called block will be wrapped into an Optional and returned. This function can be used to remove the need to manually handle exceptions when calling ObjectMapper functions.

Type Parameters:

T - the type of the block return value.

Parameters:

mapper - the ObjectMapper instance to execute with.

execution - the execution implementation to call.

Returns:

an Optional containing a potential result.

every

public static boolean every(com.fasterxml.jackson.databind.node.ArrayNode node,
                            Predicate<com.fasterxml.jackson.databind.JsonNode> predicate)

Determines whether all JsonNodes within an ArrayNode fit a provided Predicate condition.

Parameters:

node - the ArrayNode to iterate through.

predicate - the condition to verify matches against.

Returns:

true if every JsonNode value matches the Predicate.

every

public static boolean every(com.fasterxml.jackson.databind.node.ObjectNode node,
                            Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate)

Determines whether all entries within an ObjectNode fit a provided Predicate condition.

Parameters:

node - the ObjectNode to iterate through.

predicate - the condition to verify matches against.

Returns:

true if every entry value matches the Predicate.

filter

public static com.fasterxml.jackson.databind.node.ArrayNode filter(com.fasterxml.jackson.databind.node.ArrayNode node,
                                                                   Predicate<com.fasterxml.jackson.databind.JsonNode> predicate)

Filters values in an ArrayNode into a new ArrayNode. This does not modify the input ArrayNode but collects the filtered values into a new ArrayNode instance.

Parameters:

node - the ArrayNode to filter through.

predicate - the condition used to filter values.

Returns:

an ArrayNode instance containing filtered values.

filter

public static com.fasterxml.jackson.databind.node.ObjectNode filter(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                    Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate)

Filters values in an ObjectNode into a new ObjectNode. This does not modify the input ObjectNode but collects the filtered values into a new ObjectNode instance.

Parameters:

node - the ObjectNode to filter through.

predicate - the condition used to filter values.

Returns:

an ObjectNode instance containing filtered values.

find

public static Optional<com.fasterxml.jackson.databind.JsonNode> find(com.fasterxml.jackson.databind.node.ArrayNode node,
                                                                     Predicate<com.fasterxml.jackson.databind.JsonNode> predicate)

Attempts to find an ArrayNode value matching a criteria.

Parameters:

node - the ArrayNode to search.

predicate - the condition to match the values against.

Returns:

a potential JsonNode matching the predicate.

find

public static Optional<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> find(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                                       Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate)

Attempts to find an ObjectNode entry matching a criteria.

Parameters:

node - the ObjectNode to search.

predicate - the condition to match the entries against.

Returns:

a potential Map.Entry matching the predicate.

keys

public static Set<String> keys(com.fasterxml.jackson.databind.node.ObjectNode node)

Returns an Set of Strings instance containing all keys of the provided ObjectNode.

Parameters:

node - the ObjectNode to retrieve keys for.

Returns:

a Set containing all keys.

last

public static com.fasterxml.jackson.databind.JsonNode last(com.fasterxml.jackson.databind.node.ArrayNode node)

Retrieves the last value in an ArrayNode. If the ArrayNode is empty, a MissingNode instance will be returned.

Parameters:

node - a new ArrayNode instance.

Returns:

a JsonNode instance.

map

public static com.fasterxml.jackson.databind.node.ArrayNode map(com.fasterxml.jackson.databind.node.ArrayNode node,
                                                                Function<com.fasterxml.jackson.databind.JsonNode,com.fasterxml.jackson.databind.JsonNode> function)

Maps values in an ArrayNode into a new ArrayNode. This does not modify the original ArrayNode, rather it collects the mapped values into a new ArrayNode.

Parameters:

node - the ArrayNode to map.

function - the mapping function.

Returns:

an ArrayNode containing the mapped values.

map

public static com.fasterxml.jackson.databind.node.ObjectNode map(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                 Function<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>,Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> function)

Maps entries in an ObjectNode into a new ObjectNode. This does not modify the original ObjectNode, rather it collects the mapped entries into a new ObjectNode.

Parameters:

node - the ObjectNode to map.

function - the mapping function.

Returns:

an ObjectNode containing the mapped values.

merge

public static com.fasterxml.jackson.databind.node.ObjectNode merge(com.fasterxml.jackson.databind.node.ObjectNode... nodes)

Performs a shallow merge of multiple ObjectNodes. This is not a recursive merge, it will just overwrite the value on the left in case of a clash.

Parameters:

nodes - the ObjectNode instances to merge.

Returns:

a new ObjectNode instance of merged keys.

newArrayNode

public static com.fasterxml.jackson.databind.node.ArrayNode newArrayNode()

Constructs a new Jackson ArrayNode instance.

Returns:

a new Jackson ArrayNode instance.

newArrayNode

public static com.fasterxml.jackson.databind.node.ArrayNode newArrayNode(com.fasterxml.jackson.databind.JsonNode... nodes)

Constructs a new Jackson ArrayNode instance. The instance is populated with the provided JsonNode instances and returned back to the caller.

Parameters:

nodes - the nodes to populate with.

Returns:

a newly populated ArrayNode instance.

newBigIntegerNode

public static com.fasterxml.jackson.databind.node.BigIntegerNode newBigIntegerNode(@Nonnull
                                                                                   BigInteger value)

Constructs a new BigIntegerNode from a BigDecimal value.

Parameters:

value - the BigIntegerNode value of this entry.

Returns:

a new BigIntegerNode instance.

newDecimalNode

public static com.fasterxml.jackson.databind.node.DecimalNode newDecimalNode(@Nonnull
                                                                             BigDecimal value)

Constructs a new DecimalNode from a BigDecimal value.

Parameters:

value - the BigDecimal value of this entry.

Returns:

a new DecimalNode instance.

newBooleanNode

public static com.fasterxml.jackson.databind.node.BooleanNode newBooleanNode(@Nonnull
                                                                             Boolean value)

Constructs a new BooleanNode from a Boolean value.

Parameters:

value - the Boolean value of this entry.

Returns:

a new BooleanNode instance.

newBinaryNode

public static com.fasterxml.jackson.databind.node.BinaryNode newBinaryNode(@Nonnull
                                                                           byte[] value)

Constructs a new BinaryNode from a byte[] value.

Parameters:

value - the byte[] value of this entry.

Returns:

a new BinaryNode instance.

newDoubleNode

public static com.fasterxml.jackson.databind.node.DoubleNode newDoubleNode(@Nonnull
                                                                           Double value)

Constructs a new DoubleNode from a Double value.

Parameters:

value - the Double value of this entry.

Returns:

a new DoubleNode instance.

newFloatNode

public static com.fasterxml.jackson.databind.node.FloatNode newFloatNode(@Nonnull
                                                                         Float value)

Constructs a new FloatNode from a Float value.

Parameters:

value - the Float value of this entry.

Returns:

a new FloatNode instance.

newIntNode

public static com.fasterxml.jackson.databind.node.IntNode newIntNode(@Nonnull
                                                                     Integer value)

Constructs a new IntNode from an Integer value.

Parameters:

value - the Integer value of this entry.

Returns:

a new IntNode instance.

newLongNode

public static com.fasterxml.jackson.databind.node.LongNode newLongNode(@Nonnull
                                                                       Long value)

Constructs a new LongNode from a Long value.

Parameters:

value - the Long value of this entry.

Returns:

a new LongNode instance.

newPojoNode

public static com.fasterxml.jackson.databind.node.POJONode newPojoNode(@Nonnull
                                                                       Object value)

Constructs a new POJONode from an Object value.

Parameters:

value - the Object value of this entry.

Returns:

a new POJONode instance.

newShortNode

public static com.fasterxml.jackson.databind.node.ShortNode newShortNode(@Nonnull
                                                                         Short value)

Constructs a new ShortNode from a Short value.

Parameters:

value - the Short value of this entry.

Returns:

a new ShortNode instance.

newTextNode

public static com.fasterxml.jackson.databind.node.TextNode newTextNode(@Nonnull
                                                                       String value)

Constructs a new TextNode from a String value.

Parameters:

value - the String value of this entry.

Returns:

a new TextNode instance.

newIterable

public static Iterable<com.fasterxml.jackson.databind.JsonNode> newIterable(com.fasterxml.jackson.databind.JsonNode node)

Constructs a new Iterable of type JsonNode using the provided input. If the provided input is an ArrayNode, it is returned as is due to it being already iterable. Any other JsonNode is wrapped in a new instance of ArrayNode before being returned. If the provided value is null, an empty ArrayNode is returned to avoid receiving a NullPointerException.

Parameters:

node - the node to use when seeding the Iterable.

Returns:

a new Iterable of type JsonNode.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     com.fasterxml.jackson.databind.JsonNode value)

Constructs a new JSON Map.Entry from a JsonNode value.

Parameters:

key - the key of this entry as a String.

value - the JsonNode value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     BigDecimal value)

Constructs a new JSON Map.Entry from a BigDecimal value.

Parameters:

key - the key of this entry as a String.

value - the BigDecimal value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     BigInteger value)

Constructs a new JSON Map.Entry from a BigInteger value.

Parameters:

key - the key of this entry as a String.

value - the BigInteger value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     Boolean value)

Constructs a new JSON Map.Entry from a Boolean value.

Parameters:

key - the key of this entry as a String.

value - the Boolean value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     byte[] value)

Constructs a new JSON Map.Entry from a byte[] value.

Parameters:

key - the key of this entry as a String.

value - the byte[] value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     Double value)

Constructs a new JSON Map.Entry from a Double value.

Parameters:

key - the key of this entry as a String.

value - the Double value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     Float value)

Constructs a new JSON Map.Entry from a Float value.

Parameters:

key - the key of this entry as a String.

value - the Float value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     Integer value)

Constructs a new JSON Map.Entry from an Integer value.

Parameters:

key - the key of this entry as a String.

value - the Integer value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     Long value)

Constructs a new JSON Map.Entry from a Long value.

Parameters:

key - the key of this entry as a String.

value - the Long value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     Object value)

Constructs a new JSON Map.Entry from an Object value.

Parameters:

key - the key of this entry as a String.

value - the Object value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     Short value)

Constructs a new JSON Map.Entry from a Short value.

Parameters:

key - the key of this entry as a String.

value - the Short value of this entry.

Returns:

a new Map.Entry instance.

newJsonEntry

public static Map.Entry<String,com.fasterxml.jackson.databind.JsonNode> newJsonEntry(String key,
                                                                                     String value)

Constructs a new JSON Map.Entry from a String value.

Parameters:

key - the key of this entry as a String.

value - the String value of this entry.

Returns:

a new Map.Entry instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(BigDecimal value)

Constructs a new JsonNode from a BigDecimal value.

Parameters:

value - the BigDecimal value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(BigInteger value)

Constructs a new JsonNode from a BigInteger value.

Parameters:

value - the BigInteger value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(Boolean value)

Constructs a new JsonNode from a Boolean value.

Parameters:

value - the Boolean value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(byte[] value)

Constructs a new JsonNode from a byte[] value.

Parameters:

value - the byte[] value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(Double value)

Constructs a new JsonNode from a Double value.

Parameters:

value - the Double value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(Float value)

Constructs a new JsonNode from a Float value.

Parameters:

value - the Float value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(Integer value)

Constructs a new JsonNode from an Integer value.

Parameters:

value - the Integer value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(Long value)

Constructs a new JsonNode from a Long value.

Parameters:

value - the Long value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(Object value)

Constructs a new JsonNode from an Object value.

Parameters:

value - the Object value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(Short value)

Constructs a new JsonNode from a Short value.

Parameters:

value - the Short value of this entry.

Returns:

a new JsonNode instance.

newJsonNode

public static com.fasterxml.jackson.databind.JsonNode newJsonNode(String value)

Constructs a new JsonNode from a String value.

Parameters:

value - the String value of this entry.

Returns:

a new JsonNode instance.

newObjectNode

public static com.fasterxml.jackson.databind.node.ObjectNode newObjectNode()

Constructs a new Jackson ObjectNode instance.

Returns:

a new Jackson ObjectNode instance.

newObjectNode

@SafeVarargs
public static com.fasterxml.jackson.databind.node.ObjectNode newObjectNode(Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>... entries)

Constructs a new Jackson ObjectNode instance. The instance is populated with the provided entries and returned back to the caller.

Parameters:

entries - the entries to populate with.

Returns:

a newly populated ObjectNode instance.

none

public static boolean none(com.fasterxml.jackson.databind.node.ArrayNode node,
                           Predicate<com.fasterxml.jackson.databind.JsonNode> predicate)

Returns true if no values in the ArrayNode match the provided predicate.

Parameters:

node - the ArrayNode to verify.

predicate - the condition to match against.

Returns:

true if no values match the condition.

none

public static boolean none(com.fasterxml.jackson.databind.node.ObjectNode node,
                           Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate)

Returns true if no entries in the ObjectNode match the provided predicate.

Parameters:

node - the ObjectNode to verify.

predicate - the condition to match against.

Returns:

true if no entries match the condition.

omit

public static com.fasterxml.jackson.databind.node.ObjectNode omit(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                  String... keys)

Returns an ObjectNode instance without the provided list of keys using the provided ObjectNode instance.

Parameters:

node - the ObjectNode to omit from.

keys - the keys to omit.

Returns:

an ObjectNode without the omitted fields.

omit

public static com.fasterxml.jackson.databind.node.ObjectNode omit(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                  Collection<String> keys)

Returns an ObjectNode instance without the provided list of keys using the provided ObjectNode instance.

Parameters:

node - the ObjectNode to omit from.

keys - the keys to omit.

Returns:

an ObjectNode without the omitted fields.

pick

public static com.fasterxml.jackson.databind.node.ObjectNode pick(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                  String... keys)

Returns an ObjectNode instance created from the provided list of keys using the provided ObjectNode instance.

Parameters:

node - the ObjectNode to pick from.

keys - the keys to pick.

Returns:

an ObjectNode containing the picked fields.

pick

public static com.fasterxml.jackson.databind.node.ObjectNode pick(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                  Collection<String> keys)

Returns an ObjectNode instance created from the provided Set of keys using the provided ObjectNode instance.

Parameters:

node - the ObjectNode to pick from.

keys - the keys to pick.

Returns:

an ObjectNode containing the picked fields.

reduce

public static <T> T reduce(com.fasterxml.jackson.databind.node.ArrayNode node,
                           T initial,
                           BiFunction<T,com.fasterxml.jackson.databind.JsonNode,T> function)

Reduces an ArrayNode into a single value of type T using the provided function to accumulate values.

Type Parameters:

T - the type of the result.

Parameters:

node - the ArrayNode to reduce.

initial - the initial accumulator state.

function - the reducing function.

Returns:

a new instance of type T.

reduce

public static <T> T reduce(com.fasterxml.jackson.databind.node.ObjectNode node,
                           T initial,
                           BiFunction<T,Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>,T> function)

Reduces an ObjectNode into a single value of type T using the provided function to accumulate values.

Type Parameters:

T - the type of the result.

Parameters:

node - the ObjectNode to reduce.

initial - the initial accumulator state.

function - the reducing function.

Returns:

a new instance of type T.

reject

public static com.fasterxml.jackson.databind.node.ArrayNode reject(com.fasterxml.jackson.databind.node.ArrayNode node,
                                                                   Predicate<com.fasterxml.jackson.databind.JsonNode> predicate)

Filters values in an ArrayNode into a new ArrayNode. This does not modify the input ArrayNode but collects the filtered values into a new ArrayNode instance. Unlike filter(ArrayNode, Predicate) this method filters out values rather than filtering them in.

Parameters:

node - the ArrayNode to filter through.

predicate - the condition used to filter values.

Returns:

an ArrayNode instance containing filtered values.

reject

public static com.fasterxml.jackson.databind.node.ObjectNode reject(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                    Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate)

Filters values in an ObjectNode into a new ObjectNode. This does not modify the input ObjectNode but collects the filtered values into a new ObjectNode instance. Unlike filter(ObjectNode, Predicate) this method filters out values rather than filtering them in.

Parameters:

node - the ObjectNode to filter through.

predicate - the condition used to filter values.

Returns:

an ObjectNode instance containing filtered values.

some

public static boolean some(com.fasterxml.jackson.databind.node.ArrayNode node,
                           Predicate<com.fasterxml.jackson.databind.JsonNode> predicate)

Returns true if some values in the ArrayNode match the provided predicate.

Parameters:

node - the ArrayNode to verify.

predicate - the condition to match against.

Returns:

true if some values match the condition.

some

public static boolean some(com.fasterxml.jackson.databind.node.ObjectNode node,
                           Predicate<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> predicate)

Returns true if some entries in the ObjectNode match the provided predicate.

Parameters:

node - the ObjectNode to verify.

predicate - the condition to match against.

Returns:

true if some entries match the condition.

stream

public static Stream<com.fasterxml.jackson.databind.JsonNode> stream(com.fasterxml.jackson.databind.node.ArrayNode node)

Creates a new Stream from the provided ArrayNode. The Stream is created as a serial Stream so that the caller may decide to turn parallel as needed.

Parameters:

node - the ArrayNode to stream.

Returns:

a new Stream of the input elements.

stream

public static Stream<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>> stream(com.fasterxml.jackson.databind.node.ObjectNode node)

Creates a new Stream from the provided ObjectNode. The Stream is created as a serial Stream so that the caller may decide to turn parallel as needed.

Parameters:

node - the ObjectNode to stream.

Returns:

a new Stream of the input entries.

take

public static com.fasterxml.jackson.databind.node.ArrayNode take(com.fasterxml.jackson.databind.node.ArrayNode node,
                                                                 int count)

Returns a new ArrayNode containing N taken items from a provided ArrayNode instance. This does not modify the original ArrayNode input, but returns a new ArrayNode instance with the nodes taken.

Parameters:

node - the node to take from.

count - the number of nodes to take.

Returns:

a new ArrayNode instance fo the taken nodes.

transform

public static com.fasterxml.jackson.databind.node.ArrayNode transform(com.fasterxml.jackson.databind.node.ArrayNode node,
                                                                      Function<Stream<com.fasterxml.jackson.databind.JsonNode>,Stream<com.fasterxml.jackson.databind.JsonNode>> transformer)

Transforms a provided ArrayNode into a new ArrayNode instance. The provided Function maps the base Stream to a new Stream in order to transform the ArrayNode internally. The final nodes are collected back into a new ArrayNode.

Parameters:

node - the ArrayNode to transform.

transformer - the Stream transformer.

Returns:

a new ArrayNode instance after transformation.

transform

public static com.fasterxml.jackson.databind.node.ObjectNode transform(com.fasterxml.jackson.databind.node.ObjectNode node,
                                                                       Function<Stream<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>>,Stream<Map.Entry<String,com.fasterxml.jackson.databind.JsonNode>>> transformer)

Transforms a provided ObjectNode into a new ObjectNode instance. The provided Function maps the base Stream to a new Stream in order to transform the ObjectNode internally. The final entry pairs are collected back into a new ObjectNode.

Parameters:

node - the ObjectNode to transform.

transformer - the Stream transformer.

Returns:

a new ObjectNode instance after transformation.

uniq

public static com.fasterxml.jackson.databind.node.ArrayNode uniq(com.fasterxml.jackson.databind.node.ArrayNode node)

Returns an ArrayNode instance with all duplicate values removed.

Parameters:

node - the input ArrayNode to uniq.

Returns:

a new ArrayNode of unique instance.

values

public static com.fasterxml.jackson.databind.node.ArrayNode values(com.fasterxml.jackson.databind.node.ObjectNode node)

Returns an ArrayNode instance containing all values of the provided ObjectNode. Note that the returned values are in no guaranteed order.

Parameters:

node - the ObjectNode to retrieve values for.

Returns:

an ArrayNode containing all JsonNode values.