com.sap.cloud.server.odata

Class ToJSON

java.lang.Object

com.sap.cloud.server.odata.ToJSON

public abstract class ToJSON
extends java.lang.Object

A utility class for formatting OData values as JSON strings.

Constructor Summary

Constructors

Constructor and Description
ToJSON()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	complex(ComplexValue value) See complex(ComplexValue, int).
static java.lang.String	complex(ComplexValue value, int options) Format a complex value as a JSON string, including structural and navigation properties.
static java.lang.String	complexList(ComplexValueList value) See complexList(ComplexValueList, int).
static java.lang.String	complexList(ComplexValueList value, int options) Format a complex list as a JSON string, including structural and navigation properties.
static <C extends ComplexValue> java.lang.String	complexList(java.util.List<C> value) Format a generic complex list as a JSON string.
static <C extends ComplexValue> java.lang.String	complexList(java.util.List<C> value, int options) Format a generic complex list as a JSON string.
static java.lang.String	dataURI(java.lang.Object value) Convert value to OData 4.0 JSON format, then convert to a data URI with media type "application/json" and base64-encoded data.
static java.lang.String	entity(EntityValue value) See entity(EntityValue, int).
static java.lang.String	entity(EntityValue value, int options) Format an entity value as a JSON string, including structural and navigation properties.
static java.lang.String	entityKey(EntityValue value) See entityKey(EntityValue, int).
static java.lang.String	entityKey(EntityValue value, int options) Format an entity value as a JSON string, including only key properties.
static java.lang.String	entityList(EntityValueList value) See entityList(EntityValueList, int).
static java.lang.String	entityList(EntityValueList value, int options) Format an entity list as a JSON string, including structural and navigation properties.
static <E extends EntityValue> java.lang.String	entityList(java.util.List<E> value) Format a generic entity list as a JSON string.
static <E extends EntityValue> java.lang.String	entityList(java.util.List<E> value, int options) Format a generic entity list as a JSON string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToJSON

public ToJSON()

Method Detail

complexList

public static <C extends ComplexValue> java.lang.String complexList(java.util.List<C> value)

Format a generic complex list as a JSON string.

Type Parameters:

C - Complex value subclass (e.g. proxy class).

Parameters:

value - Complex list.

Returns:

JSON string.

complexList

public static <C extends ComplexValue> java.lang.String complexList(java.util.List<C> value,
                                                                    int options)

Format a generic complex list as a JSON string.

Type Parameters:

C - Complex value subclass (e.g. proxy class).

Parameters:

value - Complex list.

options - Additional bind options.

Returns:

JSON string.

entityList

public static <E extends EntityValue> java.lang.String entityList(java.util.List<E> value)

Format a generic entity list as a JSON string.

Type Parameters:

E - Entity value subclass (e.g. proxy class).

Parameters:

value - Entity list.

Returns:

JSON string.

entityList

public static <E extends EntityValue> java.lang.String entityList(java.util.List<E> value,
                                                                  int options)

Format a generic entity list as a JSON string.

Type Parameters:

E - Entity value subclass (e.g. proxy class).

Parameters:

value - Entity list.

options - Additional bind options.

Returns:

JSON string.

complex

public static java.lang.String complex(ComplexValue value)

See complex(ComplexValue, int).

Parameters:

value - Value parameter.

Returns:

(see linked method).

complex

public static java.lang.String complex(ComplexValue value,
                                       int options)

Format a complex value as a JSON string, including structural and navigation properties.

Parameters:

value - Complex value.

options - Additional bind options. See DataContext constants.

Returns:

JSON string.

complexList

public static java.lang.String complexList(ComplexValueList value)

See complexList(ComplexValueList, int).

Parameters:

value - Value parameter.

Returns:

(see linked method).

complexList

public static java.lang.String complexList(ComplexValueList value,
                                           int options)

Format a complex list as a JSON string, including structural and navigation properties.

Parameters:

value - Complex list.

options - Additional bind options. See DataContext constants.

Returns:

JSON string.

dataURI

public static java.lang.String dataURI(java.lang.Object value)

Convert value to OData 4.0 JSON format, then convert to a data URI with media type "application/json" and base64-encoded data.

Parameters:

value - (nullable) Header value.

Returns:

This object.

entity

public static java.lang.String entity(EntityValue value)

See entity(EntityValue, int).

Parameters:

value - Value parameter.

Returns:

(see linked method).

entity

public static java.lang.String entity(EntityValue value,
                                      int options)

Format an entity value as a JSON string, including structural and navigation properties.

Example using proxy classes:

 public void jsonEntityExample() {
     NorthwindService service = this.getService();
     Customer customer = new Customer(false);
     customer.setCustomerID("123");
     customer.setContactName("Four Five Six");
     customer.setCompanyName("JSON Inc.");
     customer.setOldEntity(customer.copy());
     customer.getOld().setContactName("One Two Three");
     this.showCustomer(customer);
     String json = ToJSON.entity(customer);
     Example.show(json);
     Customer restoredCustomer = service.getCustomer(FromJSON.entity(json));
     this.showCustomer(restoredCustomer);
     assert StringOperator.equal(customer.toString(),
         restoredCustomer.toString());
     assert StringOperator.equal(customer.getOld()
         .toString(), restoredCustomer.getOld().toString());
 }
 

Parameters:

value - Entity value.

options - Additional bind options. See DataContext constants.

Returns:

JSON string.

entityKey

public static java.lang.String entityKey(EntityValue value)

See entityKey(EntityValue, int).

Parameters:

value - Value parameter.

Returns:

(see linked method).

entityKey

public static java.lang.String entityKey(EntityValue value,
                                         int options)

Format an entity value as a JSON string, including only key properties.

Parameters:

value - Entity value.

options - Additional bind options. See DataContext constants.

Returns:

JSON string.

entityList

public static java.lang.String entityList(EntityValueList value)

See entityList(EntityValueList, int).

Parameters:

value - Value parameter.

Returns:

(see linked method).

entityList

public static java.lang.String entityList(EntityValueList value,
                                          int options)

Format an entity list as a JSON string, including structural and navigation properties.

Parameters:

value - Entity list.

options - Additional bind options. See DataContext constants.

Returns:

JSON string.