org.apache.paimon.utils

Class JsonSerdeUtil

java.lang.Object

org.apache.paimon.utils.JsonSerdeUtil

public class JsonSerdeUtil
extends Object

A utility class that provide abilities for JSON serialization and deserialization.

Method Summary

Modifier and Type	Method and Description
static <T extends org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode> T	asSpecificNodeType(String json, Class<T> clazz) Parses the provided JSON string and casts it to the specified type of JsonNode.
static <T> T	convertValue(Object fromValue, org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.type.TypeReference<T> toValueTypeRef)
static <T> T	extractValue(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode, Class<T> valueType, String... path) Parses a JSON string and extracts a value of the specified type from the given path keys.
static <T> T	extractValueOrDefault(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode, Class<T> valueType, T defaultValue, String... path) Parses a JSON string and extracts a value of the specified type from the given path keys.
static <T> T	fromJson(String json, Class<T> clazz)
static <T> T	fromJson(String json, org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
static <T extends org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode> T	getNodeAs(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode root, String fieldName, Class<T> clazz) Retrieves a specific node from the given root node and casts it to the specified type.
static boolean	isNodeExists(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode, String... path) Checks if a specified node exists in a JSON string.
static boolean	isNull(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode)
static <V> LinkedHashMap<String,V>	parseJsonMap(String jsonString, Class<V> valueType)
static <T> String	toFlatJson(T t)
static <T> String	toJson(T t)
static String	writeValueAsString(Object value)

Methods inherited from class java.lang.Object

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

Method Detail

parseJsonMap

public static <V> LinkedHashMap<String,V> parseJsonMap(String jsonString,
                                                       Class<V> valueType)

getNodeAs

@Nullable
public static <T extends org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode> T getNodeAs(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode root,
                                                                                                                         String fieldName,
                                                                                                                         Class<T> clazz)

Retrieves a specific node from the given root node and casts it to the specified type.

Type Parameters:

T - The type of the node to be returned.

Parameters:

root - The root node from which the specific node is to be retrieved.

fieldName - The name of the field to retrieve.

clazz - The class of the node to be returned.

Returns:

The node cast to the specified type or null if not present.

Throws:

IllegalArgumentException - if the node is not of the expected type.

fromJson

public static <T> T fromJson(String json,
                             org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

fromJson

public static <T> T fromJson(String json,
                             Class<T> clazz)

toJson

public static <T> String toJson(T t)

toFlatJson

public static <T> String toFlatJson(T t)

asSpecificNodeType

public static <T extends org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode> T asSpecificNodeType(String json,
                                                                                                                        Class<T> clazz)
                                                                                                                 throws org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException

Parses the provided JSON string and casts it to the specified type of JsonNode.

This method is useful when the exact subtype of JsonNode is known beforehand and needs to be enforced.

Type Parameters:

T - The type of the JsonNode to return. Must be a subtype of JsonNode.

Parameters:

json - The JSON string to parse.

clazz - The expected class type of the parsed JSON.

Returns:

The parsed JSON as an instance of the specified type.

Throws:

org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException - If there's an error during JSON parsing.

IllegalArgumentException - If the parsed JSON is not of the expected type.

extractValueOrDefault

public static <T> T extractValueOrDefault(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode,
                                          Class<T> valueType,
                                          T defaultValue,
                                          String... path)
                                   throws org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException

Parses a JSON string and extracts a value of the specified type from the given path keys.

Throws:

org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException

extractValue

public static <T> T extractValue(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode,
                                 Class<T> valueType,
                                 String... path)
                          throws org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException

Parses a JSON string and extracts a value of the specified type from the given path keys.

Throws:

org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException

isNodeExists

public static boolean isNodeExists(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode,
                                   String... path)

Checks if a specified node exists in a JSON string.

convertValue

public static <T> T convertValue(Object fromValue,
                                 org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.type.TypeReference<T> toValueTypeRef)

writeValueAsString

public static String writeValueAsString(Object value)
                                 throws org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException

Throws:

org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonProcessingException

isNull

public static boolean isNull(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode)