Package com.vaadin.flow.internal

Class JacksonUtils

java.lang.Object
com.vaadin.flow.internal.JacksonUtils
public final class JacksonUtils extends Object
Helpers for using jackson.

For internal use only. May be renamed or removed in a future release.

Since:
24.7
Author:
Vaadin Ltd

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    JacksonUtils.ComponentSerializer
    Custom Jackson serializer for Component that delegates to NodeSerializer.
    static class 
    JacksonUtils.NodeSerializer
    Custom Jackson serializer for Node types (Element, ShadowRoot) that serializes attached nodes as @v-node references for client-side DOM manipulation.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Collector<tools.jackson.databind.JsonNode,tools.jackson.databind.node.ArrayNode,tools.jackson.databind.node.ArrayNode>
    asArray()
    Creates a collector that collects values into a JSON array.
    static tools.jackson.databind.node.ObjectNode
    beanToJson(Object bean)
    Converts the given bean to JSON.
    static boolean
    booleanEqual(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
    Compare boolean value of two JsonNode values.
    static void
    checkJacksonCompatibility()
    Checks that the Jackson version on the classpath is compatible with this version of Vaadin by verifying that expected API methods are available.
    static tools.jackson.databind.node.ArrayNode
    createArray(tools.jackson.databind.JsonNode... values)
    Creates a new JSON array with the given values.
    static tools.jackson.databind.node.ArrayNode
    createArrayNode()
    Create a new ArrayNode.
    static tools.jackson.databind.JsonNode
    createNode(Object value)
    Create a JsonNode from value.
    static <T> tools.jackson.databind.node.ObjectNode
    createObject(Map<String,T> map, Function<T,tools.jackson.databind.JsonNode> itemToJson)
    Converts the given map into a JSON object by converting each map value to a JSON value.
    static tools.jackson.databind.node.ObjectNode
    createObjectNode()
    Create a new ObjectNode.
    static List<String>
    getKeys(tools.jackson.databind.JsonNode node)
     
    static tools.jackson.databind.ObjectMapper
    getMapper()
     
    static @Nullable tools.jackson.databind.JsonNode
    getNestedKey(tools.jackson.databind.node.ObjectNode objectNode, List<String> keyPath)
    Retrieves a nested JSON key from an object node based on a provided path.
    static boolean
    jsonEquals(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
    Compares two json values for deep equality.
    static tools.jackson.databind.node.ArrayNode
    listToJson(List<?> list)
    Converts the given list to JSON.
    static tools.jackson.databind.node.ObjectNode
    mapToJson(Map<String,?> map)
    Converts the given map to JSON.
    static tools.jackson.databind.node.ValueNode
    nullNode()
    Create a nullNode for null value.
    static boolean
    numbersEqual(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
    Compare number value of two JsonNode values.
    static DoubleStream
    numberStream(tools.jackson.databind.node.ArrayNode array)
    Creates a double stream from a JSON array of numbers.
    static Stream<tools.jackson.databind.JsonNode>
    objectStream(tools.jackson.databind.node.ArrayNode array)
    Creates a stream from a JSON array of objects.
    static <T> T
    readToObject(tools.jackson.databind.JsonNode jsonObject, Class<T> tClass)
    Converts JsonObject into Java object of given type.
    static tools.jackson.databind.node.ObjectNode
    readTree(String json)
    Read Json string to JsonNode.
    static <T> T
    readValue(tools.jackson.databind.JsonNode jsonValue, Class<T> tClass)
    Converts ObjectNode into Java object of given type.
    static <T> T
    readValue(tools.jackson.databind.JsonNode jsonValue, tools.jackson.core.type.TypeReference<T> typeReference)
    Converts ObjectNode into Java object of given type.
    static void
    removeNestedKey(tools.jackson.databind.node.ObjectNode objectNode, List<String> keyPath)
    Removes a nested key from an ObjectNode based on the provided path.
    static void
    setNestedKey(tools.jackson.databind.node.ObjectNode objectNode, List<String> keyPath, tools.jackson.databind.JsonNode valueNode, Function<? super tools.jackson.databind.JsonNode,? extends tools.jackson.databind.node.ObjectNode> plainValueConverter)
    Sets a nested JSON key path in an ObjectNode with the provided value.
    static <T extends tools.jackson.databind.JsonNode>
    Stream<T>
    stream(tools.jackson.databind.node.ArrayNode array)
    Creates a stream from a JSON array.
    static boolean
    stringEqual(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
    Compare String value of two JsonNode values.
    static String
    toFileJson(tools.jackson.databind.JsonNode node)
    Converts the given node into JSON suitable for writing into a file such as package.json.
    static tools.jackson.databind.node.BaseJsonNode
    writeValue(Object object)
    Converts Java object into ObjectNode.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getMapper

      public static tools.jackson.databind.ObjectMapper getMapper()

    • checkJacksonCompatibility

      public static void checkJacksonCompatibility()
      Checks that the Jackson version on the classpath is compatible with this version of Vaadin by verifying that expected API methods are available.
      Throws:
      IllegalStateException - if the Jackson version is not compatible

    • createObjectNode

      public static tools.jackson.databind.node.ObjectNode createObjectNode()
      Create a new ObjectNode.
      Returns:
      ObjectNode

    • createArrayNode

      public static tools.jackson.databind.node.ArrayNode createArrayNode()
      Create a new ArrayNode.
      Returns:
      ArrayNode

    • nullNode

      public static tools.jackson.databind.node.ValueNode nullNode()
      Create a nullNode for null value.
      Returns:
      NullNode

    • readTree

      public static tools.jackson.databind.node.ObjectNode readTree(String json)
      Read Json string to JsonNode.
      Parameters:
      json - the JSON string to parse
      Returns:
      JsonNode representation of given json string

    • createNode

      public static tools.jackson.databind.JsonNode createNode(Object value)
      Create a JsonNode from value.
      Parameters:
      value - the value to convert to a JsonNode
      Returns:
      JsonNode for given value content

    • jsonEquals

      public static boolean jsonEquals(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
      Compares two json values for deep equality.

      This is a helper for overcoming the fact that ObjectNode doesn't override Object.equals(Object) and { ObjectNode#jsEquals(ObjectNode)} is defined to use JavaScript semantics where arrays and objects are equals only based on identity.

      Parameters:
      a - the first json value to check, may not be null
      b - the second json value to check, may not be null
      Returns:
      true if both json values are the same; false otherwise

    • stringEqual

      public static boolean stringEqual(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
      Compare String value of two JsonNode values.
      Parameters:
      a - Value one
      b - Value two
      Returns:
      true if text content equals

    • booleanEqual

      public static boolean booleanEqual(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
      Compare boolean value of two JsonNode values.
      Parameters:
      a - Value one
      b - Value two
      Returns:
      true if text boolean equals

    • numbersEqual

      public static boolean numbersEqual(tools.jackson.databind.JsonNode a, tools.jackson.databind.JsonNode b)
      Compare number value of two JsonNode values.
      Parameters:
      a - Value one
      b - Value two
      Returns:
      true if number content equals

    • getKeys

      public static List<String> getKeys(tools.jackson.databind.JsonNode node)

    • stream

      public static <T extends tools.jackson.databind.JsonNode> Stream<T> stream(tools.jackson.databind.node.ArrayNode array)
      Creates a stream from a JSON array.
      Type Parameters:
      T - the stream type
      Parameters:
      array - the JSON array to create a stream from
      Returns:
      a stream of JSON values

    • objectStream

      public static Stream<tools.jackson.databind.JsonNode> objectStream(tools.jackson.databind.node.ArrayNode array)
      Creates a stream from a JSON array of objects. This method does not verify that all items in the array are actually JSON objects instead of some other JSON type.
      Parameters:
      array - the JSON array to create a stream from
      Returns:
      a stream of JSON objects

    • numberStream

      public static DoubleStream numberStream(tools.jackson.databind.node.ArrayNode array)
      Creates a double stream from a JSON array of numbers. This method does not verify that all items in the array are actually JSON numbers instead of some other JSON type.
      Parameters:
      array - the JSON array to create a stream from
      Returns:
      a double stream of the values in the array

    • asArray

      public static Collector<tools.jackson.databind.JsonNode,tools.jackson.databind.node.ArrayNode,tools.jackson.databind.node.ArrayNode> asArray()
      Creates a collector that collects values into a JSON array.
      Returns:
      the collector

    • createArray

      public static tools.jackson.databind.node.ArrayNode createArray(tools.jackson.databind.JsonNode... values)
      Creates a new JSON array with the given values.
      Parameters:
      values - the values that should be in the created array
      Returns:
      the created array

    • createObject

      public static <T> tools.jackson.databind.node.ObjectNode createObject(Map<String,T> map, Function<T,tools.jackson.databind.JsonNode> itemToJson)
      Converts the given map into a JSON object by converting each map value to a JSON value.
      Type Parameters:
      T - the type of the map values
      Parameters:
      map - the map to convert into a JSON object
      itemToJson - callback for converting map values to JSON
      Returns:
      the created object

    • beanToJson

      public static tools.jackson.databind.node.ObjectNode beanToJson(Object bean)
      Converts the given bean to JSON.
      Parameters:
      bean - the bean to convert, not null
      Returns:
      a JSON representation of the bean

    • listToJson

      public static tools.jackson.databind.node.ArrayNode listToJson(List<?> list)
      Converts the given list to JSON.
      Parameters:
      list - the list to convert, not null
      Returns:
      a JSON representation of the bean

    • mapToJson

      public static tools.jackson.databind.node.ObjectNode mapToJson(Map<String,?> map)
      Converts the given map to JSON.
      Parameters:
      map - the map to convert, not null
      Returns:
      a JSON representation of the bean

    • readToObject

      public static <T> T readToObject(tools.jackson.databind.JsonNode jsonObject, Class<T> tClass)
      Converts JsonObject into Java object of given type.
      Type Parameters:
      T - type of result instance
      Parameters:
      jsonObject - JSON object to convert, not null
      tClass - class of converted object instance
      Returns:
      converted object instance

    • readValue

      public static <T> T readValue(tools.jackson.databind.JsonNode jsonValue, Class<T> tClass)
      Converts ObjectNode into Java object of given type.
      Type Parameters:
      T - type of result instance
      Parameters:
      jsonValue - JSON value to convert, not null
      tClass - class of converted object instance
      Returns:
      converted object instance

    • readValue

      public static <T> T readValue(tools.jackson.databind.JsonNode jsonValue, tools.jackson.core.type.TypeReference<T> typeReference)
      Converts ObjectNode into Java object of given type.
      Type Parameters:
      T - type of result instance
      Parameters:
      jsonValue - JSON value to convert, not null
      typeReference - type reference of converted object instance
      Returns:
      converted object instance

    • writeValue

      public static tools.jackson.databind.node.BaseJsonNode writeValue(Object object)
      Converts Java object into ObjectNode.
      Parameters:
      object - Java object to convert
      Returns:
      converted JSON value

    • toFileJson

      public static String toFileJson(tools.jackson.databind.JsonNode node) throws tools.jackson.core.JacksonException
      Converts the given node into JSON suitable for writing into a file such as package.json.
      Parameters:
      node - the node to convert
      Returns:
      the JSON string
      Throws:
      tools.jackson.core.JacksonException - if the node cannot be converted

    • getNestedKey

      public static @Nullable tools.jackson.databind.JsonNode getNestedKey(tools.jackson.databind.node.ObjectNode objectNode, List<String> keyPath)
      Retrieves a nested JSON key from an object node based on a provided path.
      Parameters:
      objectNode - the root object node to search within
      keyPath - the nested key path
      Returns:
      the value of the last key found, or null

    • setNestedKey

      public static void setNestedKey(tools.jackson.databind.node.ObjectNode objectNode, List<String> keyPath, tools.jackson.databind.JsonNode valueNode, Function<? super tools.jackson.databind.JsonNode,? extends tools.jackson.databind.node.ObjectNode> plainValueConverter)
      Sets a nested JSON key path in an ObjectNode with the provided value.

      This method handles both direct and nested key assignments. If the current node at the specified top-level key does not exist not an ObjectNode, it converts it to one using the provided converter function, before proceeding with the remaining keys in the path.

      Parameters:
      objectNode - the root object where the key path will be set
      keyPath - the nested key path
      valueNode - the value to be assigned
      plainValueConverter - a function that converts intermediate null and non-ObjectNode values into ObjectNodes when necessary for recursive traversal

    • removeNestedKey

      public static void removeNestedKey(tools.jackson.databind.node.ObjectNode objectNode, List<String> keyPath)
      Removes a nested key from an ObjectNode based on the provided path. Also removes nested objects, if they become empty after key removal.
      Parameters:
      objectNode - the root object containing to process
      keyPath - the nested key path