Package com.veeva.vault.sdk.api.json

Interface JsonService

All Superinterfaces:
Service
public interface JsonService extends Service
Service for reading and writing JSON data.

  • Method Details

    • readJson

      JsonData readJson(String jsonString)
      Parses the JSON string and returns a JsonData.
      Parameters:
      jsonString - a valid JSON string where the root is an object. Cannot be null or empty.
      Returns:
      a JsonData

    • newJsonObjectBuilder

      JsonObjectBuilder newJsonObjectBuilder()
      Retrieves a new JsonObjectBuilder.
      Returns:
      a new JSON object builder

    • newJsonArrayBuilder

      JsonArrayBuilder newJsonArrayBuilder()
      Retrieves a new JsonArrayBuilder.
      Returns:
      a new JSON array builder

    • newJsonObjectBuilder

      JsonObjectBuilder newJsonObjectBuilder(JsonObject jsonObject)
      Retrieves a new JsonObjectBuilder with all the properties of the provided JsonObject.
      Parameters:
      jsonObject - the JSON object whose properties should be added to the builder
      Returns:
      a new JSON object builder

    • newJsonArrayBuilder

      JsonArrayBuilder newJsonArrayBuilder(JsonArray jsonArray)
      Retrieves a new JsonArrayBuilder with all the values of the provided JsonArray.
      Parameters:
      jsonArray - the JSON array whose values should be added to the builder
      Returns:
      a new JSON array builder

    • convertToUserDefinedModel

      <U extends UserDefinedModel> U convertToUserDefinedModel(JsonObject jsonObject, Class<U> udmClass)
      Convert a JsonObject into a UserDefinedModel.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      jsonObject - The JsonData to convert
      udmClass - The UserDefinedModel class that represents the JsonData
      Returns:
      The UserDefinedModel instance populated by the JsonObject

    • convertToUserDefinedModel

      <U extends UserDefinedModel> U convertToUserDefinedModel(String jsonObject, Class<U> udmClass)
      Convert a JSON String into a UserDefinedModel.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      jsonObject - The JSON String to convert
      udmClass - The UserDefinedModel class that represents the JsonData
      Returns:
      The UserDefinedModel instance populated by the JsonObject

    • convertToJson

      <U extends UserDefinedModel> JsonArray convertToJson(Collection<U> udmCollection)
      Convert from a Collection (List or Set) of UserDefinedModel objects into a JsonArray.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      udmCollection - Collection of UDM objects
      Returns:
      JsonArray

    • convertToString

      <U extends UserDefinedModel> String convertToString(Collection<U> udmCollection)
      Convert from a Collection (List or Set) of UserDefinedModel objects into a JsonArray String.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      udmCollection - Collection of UDM objects
      Returns:
      JsonArray String

    • convertToJson

      <U extends UserDefinedModel> JsonObject convertToJson(U udm)
      Convert from a UserDefinedModel instance into a JsonObject.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      udm - A UserDefinedModel instance
      Returns:
      JsonObject

    • convertToString

      <U extends UserDefinedModel> String convertToString(U udm)
      Convert from a UserDefinedModel instance into a JsonObject String.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      udm - A UserDefinedModel instance
      Returns:
      JsonObject String

    • convertToList

      <U extends UserDefinedModel> List<U> convertToList(JsonArray jsonArray, Class<U> udmClass)
      Convert a JsonArray into a List of UserDefinedModel objects.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      jsonArray - The JsonArray to convert
      udmClass - The UserDefinedModel class for each element in the JsonArray
      Returns:
      A List with UserDefineModel instances within it

    • convertToSet

      <U extends UserDefinedModel> Set<U> convertToSet(JsonArray jsonArray, Class<U> udmClass)
      Convert a JsonArray into a Set of UserDefinedModel objects.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      jsonArray - The JsonArray to convert
      udmClass - The UserDefinedModel class for each element in the JsonArray
      Returns:
      A Set with UserDefineModel instances within it

    • convertToList

      <U extends UserDefinedModel> List<U> convertToList(String jsonArray, Class<U> udmClass)
      Convert a String JsonArray into a List of UserDefinedModel objects.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      jsonArray - The JsonArray to convert
      udmClass - The UserDefinedModel class for each element in the JsonArray
      Returns:
      A List with UserDefineModel instances within it

    • convertToSet

      <U extends UserDefinedModel> Set<U> convertToSet(String jsonArray, Class<U> udmClass)
      Convert a String JsonArray into a Set of UserDefinedModel objects.
      Type Parameters:
      U - type of UserDefinedModel
      Parameters:
      jsonArray - The JsonArray to convert
      udmClass - The UserDefinedModel class for each element in the JsonArray
      Returns:
      A Set with UserDefineModel instances within it