Package com.sap.cds

Interface CdsJsonConverter

@Beta
public interface CdsJsonConverter

Converts JSON data to and from CDS (Core Data Services) data structures.

Provides methods for serializing and deserializing JSON objects and arrays, as well as validating data against CDS types.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CdsJsonConverter.Builder	Builder interface for configuring and building a CdsJsonConverter instance.
static enum	CdsJsonConverter.DecimalSerialization	Enum defining the serialization of CDS Decimal types to JSON.
static interface	CdsJsonConverter.Factory	Factory interface for creating CdsJsonConverter.Builder instances.
static enum	CdsJsonConverter.UnknownPropertyHandling	Defines how to handle JSON properties not declared in the CDS type.

Field Summary

Fields

Modifier and Type	Field	Description
static final CdsJsonConverter.Factory	factory	The factory instance for creating CdsJsonConverter.Builder instances.

Method Summary

Modifier and Type	Method	Description
static CdsJsonConverter.Builder	builder(CdsModel model)	Creates a new builder for configuring and building a CdsJsonConverter.
List<CdsData>	fromJsonArray(String jsonArray, CdsStructuredType type)	Parses a JSON array string into a list of CdsData using the given CDS structured type.
<T extends CdsData> List<T>	fromJsonArray(String jsonArray, Class<T> type)	Parses a JSON array string into a list of the given CdsData subtype.
CdsData	fromJsonObject(String jsonObject, CdsStructuredType type)	Parses a JSON object string into CdsData using the given CDS structured type.
<T extends CdsData> T	fromJsonObject(String jsonObject, Class<T> type)	Parses a JSON object string into the given CdsData subtype.
String	toJson(List<? extends Map<String,Object>> data)	Serializes a list of Map instances to a JSON array string.
String	toJson(Map<String,Object> data)	Serializes a Map instance to a JSON object string.

Field Details

factory

static final CdsJsonConverter.Factory factory

The factory instance for creating CdsJsonConverter.Builder instances.

Method Details

fromJsonObject

CdsData fromJsonObject(String jsonObject,
 CdsStructuredType type)

Parses a JSON object string into CdsData using the given CDS structured type.

Parameters:

jsonObject - JSON object as string (not null)

type - CDS structured type (not null)

Returns:

parsed CdsData

Throws:

CdsJsonConverterException - if parsing or mapping fails

fromJsonObject

<T extends CdsData> T fromJsonObject(String jsonObject,
 Class<T> type)

Parses a JSON object string into the given CdsData subtype.

Type Parameters:

T - target CDS data type

Parameters:

jsonObject - JSON object as string (not null)

type - target class (not null)

Returns:

parsed instance of type

Throws:

CdsJsonConverterException - if parsing or mapping fails

CdsDefinitionNotFoundException - if the CDS type is unknown

fromJsonArray

List<CdsData> fromJsonArray(String jsonArray,
 CdsStructuredType type)

Parses a JSON array string into a list of CdsData using the given CDS structured type.

Parameters:

jsonArray - JSON array as string (not null)

type - CDS structured type (not null)

Returns:

list of parsed CdsData

Throws:

CdsJsonConverterException - if parsing or mapping fails

fromJsonArray

<T extends CdsData> List<T> fromJsonArray(String jsonArray,
 Class<T> type)

Parses a JSON array string into a list of the given CdsData subtype.

Type Parameters:

T - target CDS data type

Parameters:

jsonArray - JSON array as string (not null)

type - target class (not null)

Returns:

list of parsed instances of type

Throws:

CdsJsonConverterException - if parsing or mapping fails

CdsDefinitionNotFoundException - if the CDS type is unknown

toJson

String toJson(Map<String,Object> data)

Serializes a Map instance to a JSON object string.

Parameters:

data - map instance to serialize (not null)

Returns:

JSON object as string

Throws:

CdsJsonConverterException - if serialization fails

toJson

String toJson(List<? extends Map<String,Object>> data)

Serializes a list of Map instances to a JSON array string.

Parameters:

data - list of instances to serialize (not null)

Returns:

JSON array as string

Throws:

CdsJsonConverterException - if serialization fails

builder

static CdsJsonConverter.Builder builder(CdsModel model)

Creates a new builder for configuring and building a CdsJsonConverter.

Parameters:

model - the CdsModel to be used for validation during conversion

Returns:

a new CdsJsonConverter.Builder instance

Throws:

CdsJsonConverterException - in case of an error